The FireCARES application
A quick way to get started is with Vagrant and VirtualBox.
-
Add
.env.localfile to project root (this file can be obtained in the 1Password account for Firecares). -
Run
./build.shto build the Docker container. -
Run
./run.shto start the Firecares app. -
Load snapshot of Firecares Database (if you don't have .pg_conf, consult a system admin for RDS host credentials)
psql -h 0.0.0.0 -U firecares -p 5433 -W -c 'create database firecares' pg_dump -d "service=exposure" -f firecares.sql psql -h 0.0.0.0 -U firecares -W firecares < firecares.sql
-
Load snapshot of NFIRS Database (if you don't have .pg_conf, consult a system admin for RDS host credentials)
psql -h 0.0.0.0 -U firecares -p 5433 -W -c 'create database nfirs' pg_dump -d "service=nfirs" --schema=public -f nfirs.sql psql -h 0.0.0.0 -U firecares -W nfirs < nfirs.sql
-
Finally, you should be able to open see the app in your browser by opening:
0.0.0.0:8000
To make tileserver changes, see the Prominent Edge tessera-ansible repository, specifically the firecares branch
We use pre-commit, see how to install in your local repository.
You'll need the following commands to run all of the unit tests. Tests are run on each commit automatically, so please run them yourself before you commit.
docker exec -it firecares_firecares_1 bash -c "python ./manage.py test
vagrant ssh
sudo su firecares
workon firecares
python manage.py testAdditionally, individual tests can be run using the full module/classname/test name path. If not testing migrations --keepdb will significantly speed up the whole process:
python manage.py test firecares.firestation.tests.test_metrics:FireDepartmentMetricsTests.test_calculate_structure_counts --noinput --keepdbThis project uses LESS CSS pre-processor to generate CSS rules. To make a modification to a CSS rule, follow these steps:
- Make the modification in the appropriate LESS file. For example: style.less
- Use the
lessccommand to compile the CSS from LESS and pipe the output to the appropriate locationlessc style.less > ../css/style.css.
To assist in the transparency of the calculations and data analysis, ipython notebooks in the /scripts folder can be run from your vagrant machine via:
ssh -L 8888:localhost:8888 vagrant@192.168.33.15
sudo chmod a+rwx /run/user/1000
sudo su firecares
workon firecares
python manage.py shell_plus --notebook --no-browser # follow the instructions that follow in your shell regarding logging into ipython with a tokenWhen developing client-side functionality for FireCARES it is often helpful to symlink client-side assets so they refresh when the browser is refreshed.
vagrant ssh
sudo sed -i '/location \/static/a sendfile off;' /etc/nginx/sites-enabled/firecares
sudo service nginx restart
sudo su firecares
workon firecares
python manage.py collectstatic --noinput -l --clearIn order to test the osgeo_importer functionality within FireCARES, specifically being able to step via debugger into specific celery processes, you will need to ensure that CELERY_ALWAYS_EAGER = True; however, this will not yield a resulting task state other than PENDING so items that depend on a celery result will never finish (eg. the osgeo upload dialog will never close on its own). Additionally, in order to support a multi-node deployment, celery results are stored using the memcached backend and the actual uploaded file is pushed/pulled to/from an S3 bucket as specified by OSGEO_STORAGE_BUCKET_NAME before being acted-upon by GDAL, but specifying a bucket name is not necessary for local development as the FireCARES importer and inspector can handle these tasks using a local filesystem.
- All images depend on Dockerfile-base. This is built one time only; no job in Jenkins:
make build-base
make push-base