https://github.com/tbdsux/koyo
Website screenshot service api on Deta Space
https://github.com/tbdsux/koyo
deta-space screenshot website-screenshot
Last synced: about 1 year ago
JSON representation
Website screenshot service api on Deta Space
- Host: GitHub
- URL: https://github.com/tbdsux/koyo
- Owner: tbdsux
- Archived: true
- Created: 2022-11-29T15:54:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-06T17:10:42.000Z (about 3 years ago)
- Last Synced: 2024-11-05T19:43:48.593Z (over 1 year ago)
- Topics: deta-space, screenshot, website-screenshot
- Language: Svelte
- Homepage: https://alpha.deta.space/discovery/@theboringdude/koyo
- Size: 515 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
koyo
Web screenshot service api
## [CLI](./cli/koyo)
## 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`](https://deta.space/docs/en/basics/micros#api-keys) for security purposes.
- Added **Save To Drive** screenshot api option. Can also view saved screenshots.
- Add more features for [CLI](./cli/koyo/README.md)
### v0.2.0
- Bug fixes and some minor adjustments and additions
- Download image button
### v0.1.1
- Whitehole integration from https://alpha.deta.space/discovery/@mikhailsdv/black_hole-3kf
## Known Issues
- Full page screenshot doesn't work on some websites.
## Development
This project is a monorepo using `pnpm`.
- Clone the repository
```sh
git clone https://github.com/tbdsux/koyo.git
```
- Install the dependencies
```sh
pnpm install
```
- Start development. This will run the both the api and frontend projects together simultaneously.
```sh
pnpm dev
```
### Project structure
- `api` - Expressjs, main screenshot api.
- `website` - Sveltekit website frontend.
##
**© 2022 | tbdsux**