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.

Running the api alone

Refer to api/README.md.

Running the front end alone

Refer to web/README.md

License

Apache 2.0 License - see the LICENSE.md

Glossary

A glossary of terms relating to Wildfire that are relevant to Predictive Services can be found at the Predictive Wildfire Wiki Glossary Page

Architecture

Contributing

Branch naming conventions

Branches must be named in accordance with the rules specified in .githooks/pre-push.

• branch names should be informative, meaningful and concise.
• branch names should follow the pattern (category)/(description)/(ticket number)

# Enforce branch naming conventions for this project using git hooks.
git config core.hooksPath .githooks

example of a good branch name:

# Task related to re-factoring of logging, the ticket number being 123:
task/re-factor-logging/123

example of a bad branch name:

wps-123

How to contribute

Resources:

• Issues
• ZenHub Board
• PEP8 and PEP20 coding conventions, but with 110 character line breaks
• Code of Conduct

Acknowledgments