Installation

Dependencies

• git
• docker + docker-compose

Cloning

git clone https://github.com/toobigtoignore/issf

Docker

Install Docker

Install docker using the official docs as well as docker-compose using the official docs.

Additional Docker Configuration

On Linux you may need to issue the following commands:

sudo groupadd docker

sudo usermod -aG docker $USER

Then, you may want/need to set the Docker service to automatically run on boot.

sudo systemctl enable docker

Then make sure you reboot for these changes to take effect!

Also consider installing the command completion for bash or zsh.

Running the code

1. Copy the sample environment variable file by running cp issf_prod/.env.dist issf_prod/.env
2. Download and run the containers by running docker-compose up -d
3. Run ./scripts/postgres_setup.sh to populate the database with sample data

Using the auto-collectstatic script

If you are doing a lot of frontend development, you may want to use the web_collectstatic.sh script from the scripts folder so you don't have to run python manage.py collectstatic every time you make a change. Using this script is incredibly simple. All you need to do is first ensure inotifywait is installed. The method of installing this will vary based on what operating system you are running and what package manager you have, but to install it on a debian-based linux distribution you can just run sudo apt-get install inotify-tools

Then, you can just run ./scripts/web_collectstatic.sh, and you should see console output from the static assets being auto-collected every time you make a change to a file under static_root

Troubleshooting

Docker freezes when pulling an image

• Try restarting your machine / VM and docker
• Uninstall and reinstall docker
• If in a VM, try changing your network adapter from NAT to Bridged Adapter