FireCARES

The FireCARES application

Getting Started

A quick way to get started is with Vagrant and VirtualBox.

Requirements

• Ansible
• Vagrant
• VirtualBox

git clone https://github.com/FireCARES/firecares.git
git clone https://github.com/FireCARES/firecares-ansible.git
cd firecares-ansible
vagrant up

Wait a few minutes for the magic to happen. Access the app by going to this URL: http://192.168.33.15

Development Considerations

When you install FireCARES using Vagrant, the default configuration will restart the Gunicorn process on every request so your server-side modifications should immediately show up.

For client-side changes, you currently need to manually run the collectstatic in order to update the static assets. You can run collect static from the firecares-ansible directory on the host machine using the following command:

ansible-playbook vagrant.yml -i vagrant_server --tags django.collectstatic

Unit Testing

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.

vagrant ssh
sudo su firecares
workon firecares
python manage.py test

Generating CSS

This project uses LESS CSS pre-processor to generate CSS rules. To make a modification to a CSS rule, follow these steps:

1. Make the modification in the appropriate LESS file. For example: style.less
2. Use the lessc command to compile the CSS from LESS and pipe the output to the appropriate location lessc style.less > ../css/style.css.

Symlinking Static Files

When 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 --clear