You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Document the data model and end-to-end alert flow at the top, with a
link to CONTRIBUTING.md for the full breakdown.
- Split Quick Tour into a user path (docker compose pull/up against the
published image, no Poetry needed) and a contributor path (make run,
which builds locally and requires Poetry).
- Fix the docs URL: 8080 -> 5050 to match docker-compose.yml.
- Drop the outdated Swagger screenshot from the v0.1.2 release.
- Remove the dead Heroku redoc badge (also fixes its brain=main typo).
- Reframe the Contributing section to highlight that CONTRIBUTING.md
also covers data model, codebase tour and developer setup.
The building blocks of our wildfire detection & monitoring API.
34
31
32
+
The API stores access metadata (Users, Cameras, Organizations), the core wildfire-monitoring workflow (Detections grouped into Sequences), and client integrations (Webhooks). End to end, an alert flows like this: an admin registers a user, the user registers a camera and mints a camera token, then the camera uploads a picture as a detection, which is grouped into a sequence over a dense time window. For the full data model, UML diagram, codebase tour and developer setup, see [`CONTRIBUTING.md`](CONTRIBUTING.md).
33
+
35
34
## Quick Tour
36
35
37
-
### Running/stopping the service
36
+
Two ways to run the stack, depending on whether you just want to use the API or to develop against it.
38
37
39
-
You can run the API containers using this command:
38
+
### As a user (no Poetry needed)
39
+
40
+
Pull the published `ghcr.io/pyronear/alert-api` image and start the stack:
40
41
41
42
```shell
42
-
make run
43
+
cp .env.example .env
44
+
docker compose pull
45
+
docker compose up
43
46
```
44
47
45
-
You can now navigate to `http://localhost:8080/docs` to interact with the API (or do it through HTTP requests) and explore the documentation.
48
+
Then navigate to [http://localhost:5050/docs](http://localhost:5050/docs) to interact with the API and explore the OpenAPI documentation.
### As a contributor (builds locally, requires Poetry)
48
56
49
-
In order to stop the service, run:
57
+
```shell
58
+
make run
59
+
```
60
+
61
+
This regenerates `requirements.txt` from `poetry.lock` and builds the backend image locally, so it requires [Poetry](https://python-poetry.org/docs/) to be installed. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the full developer setup, tests, and migration workflow.
You can now access your backend API at [http://localhost:5050/docs](http://localhost:5050/docs)
85
+
Then run the stack as described in the [Quick Tour](#quick-tour) above.
84
86
85
87
86
88
## More goodies
@@ -94,7 +96,7 @@ This project is a REST-API, and you can interact with the service through HTTP r
94
96
95
97
Any sort of contribution is greatly appreciated!
96
98
97
-
You can find a short guide in [`CONTRIBUTING`](CONTRIBUTING.md) to help grow this project!
99
+
[`CONTRIBUTING.md`](CONTRIBUTING.md)covers more than the contribution guidelines: it also documents the data model, codebase structure, developer setup, testing workflow and database migrations. Start there if you want to understand how the project is organised.
0 commit comments