Docker Browser 🖥️

Docker Browser is simple to use and extend REST API meant to simplify screenshot preview, reports, and analysis.

Usage

Add Docker Browser to your docker-compose.yml.

services:
  appwrite-browser:
    image: appwrite/browser:0.1.0

Start Docker Browser alongside rest of your services.

docker compose up -d

Communicate with Docker Browser endpoints.

curl -X POST -H 'content-type: application/json' -d '{"url":"http://google.com/ping"}'  http://appwrite-browser:3000/v1/screenshots

Development

Make sure you have pnpm installed.

To install dependencies, run the following command.

pnpm i

Next, start the server by running npm start, and visit use endpoint http://localhost:3000 as REST API endpoint.

Contributing

All code contributions, including those of people having commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.