Giter Club home page Giter Club logo

koyo's Introduction

koyo

Web screenshot service api

API

You will need to create an API Key from your Koyo space app before communicating through the screenshot api outside of space app.

Structure

  • /api/screenshot

    Main screenshot api. Options can be viewed and modifed through your space app instance.

  • /api/drive/files

    List saved screenshot files from the default app drive. Filename is sorted with {iso-date-string}-{website-hostname}.{image-type} (Example: 2023-02-07T09:49:11.890Z-www.google.com.png)

  • /api/drive/files/{filename}

    Endpoint for saved screenshot filename. It will return the image buffer / data if it exists otherwise, will return an Error 404 json object.

Changelog

v0.3.0

  • Added API Keys for security purposes.
  • Added Save To Drive screenshot api option. Can also view saved screenshots.
  • Add more features for CLI

v0.2.0

  • Bug fixes and some minor adjustments and additions
  • Download image button

v0.1.1

Known Issues

  • Full page screenshot doesn't work on some websites.

Development

This project is a monorepo using pnpm.

  • Clone the repository

    git clone https://github.com/tbdsux/koyo.git
  • Install the dependencies

    pnpm install
  • Start development. This will run the both the api and frontend projects together simultaneously.

    pnpm dev

Project structure

  • api - Expressjs, main screenshot api.

  • website - Sveltekit website frontend.

© 2022 | tbdsux

koyo's People

Contributors

tbdsux avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.