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 to view the front end served up from a static folder by the python api.
5. Open 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.

Running the front end alone

Refer to web/README.md

Documentation

• Database
• Devops
• Conventions
• Wildfire Glossary

License

Apache 2.0 License - see the LICENSE.md

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
• ZenHub Board
• PEP8 and PEP20 coding conventions, but with 110 character line breaks
• Code of Conduct

Acknowledgments