Update README.md

This commit is contained in:
Miguel Sozinho Ramalho
2025-02-18 15:51:16 +00:00
committed by GitHub
parent 057324dae7
commit 6c61d2cd8f

View File

@@ -4,6 +4,8 @@
A web API that uses celery workers to process URL archive requests via [bellingcat/auto-archiver](https://github.com/bellingcat/auto-archiver), it allows authentication via Google OAuth Apps and enables CORS, everything runs on docker but development can be done without docker (except for redis). A web API that uses celery workers to process URL archive requests via [bellingcat/auto-archiver](https://github.com/bellingcat/auto-archiver), it allows authentication via Google OAuth Apps and enables CORS, everything runs on docker but development can be done without docker (except for redis).
![image](https://github.com/user-attachments/assets/905d697d-b83e-437b-87d1-cc86d3c8d8bf)
## setup ## setup
To properly set up the API you need to install `docker` and to edit 3 files: To properly set up the API you need to install `docker` and to edit 3 files:
1. a `.env.prod` and `.env.dev` to configure the API, stays at the root level 1. a `.env.prod` and `.env.dev` to configure the API, stays at the root level