18 lines (12 loc) · 1.01 KB

Contributing

There are two pieces to screenshotter that are worth noting before you begin development.

The backend screenshot generator located in /api/index.ts
The frontend inputs located in /web/index.ts

Vercel handles routing in an elegate way for us so deployment is easy.

To start hacking, do the following:

Clone this repo with git clone https://github.com/wei/screenshotter
Change directory with cd screenshotter
Run npm install to install all dependencies
Run locally with vercel dev and visit localhost:3000 (if nothing happens, run npm install -g vercel)
If necessary, edit the exePath in options.ts to point to your local Chrome executable

Now you're ready to start local development!