Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcgov/wps
Wildfire Predictive Services to support decision making in prevention, preparedness, response and recovery
https://github.com/bcgov/wps
bcws cffdrs fastapi flnr hacktoberfest javascript postgis postgres postgresql python react typescript weather wildfire
Last synced: about 1 month ago
JSON representation
Wildfire Predictive Services to support decision making in prevention, preparedness, response and recovery
- Host: GitHub
- URL: https://github.com/bcgov/wps
- Owner: bcgov
- License: apache-2.0
- Created: 2020-01-23T18:42:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-11T17:57:00.000Z (3 months ago)
- Last Synced: 2024-06-11T18:20:14.161Z (3 months ago)
- Topics: bcws, cffdrs, fastapi, flnr, hacktoberfest, javascript, postgis, postgres, postgresql, python, react, typescript, weather, wildfire
- Language: Python
- Homepage:
- Size: 54.1 MB
- Stars: 36
- Watchers: 10
- Forks: 6
- Open Issues: 542
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - Wildfire Predictive Services - Wildfire Predictive Services to support decision making in prevention, preparedness, response and recovery. (Biosphere / Wildfire)
README
[](/../../issues)
[](/LICENSE)
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[](https://codecov.io/gh/bcgov/wps)
# Wildfire Predictive Services
## Description
Wildfire Predictive Services to support decision making in prevention, preparedness, response and recovery.
## Getting Started
### Dependencies
### Installing
#### Running the application locally in docker:
1. Create `.env` file in `web` using `web/.env.example` as a sample.
2. Create `.env.docker` file in `api/app` using `api/app/.env.example` as a sample.
3. Run `docker compose build` and then `docker compose up`
4. Open [http://localhost:8080](http://localhost:8080) to view the front end served up from a static folder by the python api.
5. Open [http://localhost:3000](http://localhost:3000) to view the front end served up in developer mode by node.
#### Developing the application in a dev container, using vscode:
- Open up the project: `Remote-Containers: Open Folder in Container`, select docker-compose.vscode.yml
- Sometimes VSCode doesn't pick up you've changed the docker container: `Remote-Containers: Rebuild Container`
- Install extensions into the container, as needed.
- You can point the API database to: `host.docker.internal`
- You can start up other services outside of vscode, e.g.: `docker compose up db` and `docker compose up redis`
#### Running the api alone
Refer to [api/README.md](api/README.md).
#### Running the front end alone
Refer to [web/README.md](web/README.md)
### Documentation
- [Database](docs/DB.md)
- [Devops](docs/DEVOPS.md)
- [Conventions](docs/CONVENTIONS.md)
- [Wildfire Glossary](https://github.com/bcgov/wps/wiki/Glossary)
## License
[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) License - see the [LICENSE.md](https://github.com/bcgov/wps/blob/main/LICENSE)
## Contributing
### PRs
Your Github PR is required to pass all our CI checks, including our test coverage threshold via CodeCov: https://docs.codecov.com/docs/about-code-coverage
### Resources
- [Issues](https://github.com/bcgov/wps/issues)
- [ZenHub Board](https://app.zenhub.com/workspaces/wildfire-predictive-services-5e321393e038fba5bbe203b8/board?repos=235861506,237125626,237125691)
- [PEP8](https://github.com/python/peps/blob/master/pep-0008.txt) and [PEP20](https://github.com/python/peps/blob/master/pep-0020.txt) coding conventions, but with 110 character line breaks
- [Code of Conduct](https://github.com/bcgov/wps/blob/master/CONDUCT.md)
## Acknowledgments
[](https://sonarcloud.io/dashboard?id=bcgov_wps)