Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pyronear/pyro-api
Alert Management API for wildfire prevention, detection & monitoring
https://github.com/pyronear/pyro-api
api-rest docker fastapi postgresql python wildfire-management
Last synced: 28 days ago
JSON representation
Alert Management API for wildfire prevention, detection & monitoring
- Host: GitHub
- URL: https://github.com/pyronear/pyro-api
- Owner: pyronear
- License: apache-2.0
- Created: 2020-09-30T15:59:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T14:44:52.000Z (7 months ago)
- Last Synced: 2024-04-14T00:31:50.096Z (7 months ago)
- Topics: api-rest, docker, fastapi, postgresql, python, wildfire-management
- Language: Python
- Homepage:
- Size: 7.16 MB
- Stars: 21
- Watchers: 8
- Forks: 8
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pyronear API
The building blocks of our wildfire detection & monitoring API.
## Quick Tour
### Running/stopping the service
You can run the API containers using this command:
```shell
make run
```
You can now navigate to `http://localhost:8080/docs` to interact with the API (or do it through HTTP requests) and explore the documentation.
In order to stop the service, run:
```shell
make stop
```
## Installation
### Prerequisites
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Docker](https://docs.docker.com/engine/install/)
- [Docker compose](https://docs.docker.com/compose/)
### Starting your service
#### 1 - Clone the repository
```shell
git clone https://github.com/pyronear/pyro-api.git && cd pyro-api
```
#### 2 - Set your environment variables
First copy the example environment setup
```shell
cp .env.example .env
```
#### 3 - Start the services
```shell
docker compose pull
docker compose up
```
#### 4 - Check how what you've deployed
You can now access your backend API at [http://localhost:5050/docs](http://localhost:5050/docs)
## More goodies
### Python client
This project is a REST-API, and you can interact with the service through HTTP requests. However, if you want to ease the integration into a Python project, take a look at our [Python client](client).
## Contributing
Any sort of contribution is greatly appreciated!
You can find a short guide in [`CONTRIBUTING`](CONTRIBUTING.md) to help grow this project!
## License
Distributed under the Apache 2.0 License. See [`LICENSE`](LICENSE) for more information.