To interact with the test database, you will need the Git Large File Storage extension. This is the recommended way to handle large files (or files that could eventually become quite large).

For OSX users, the extension can be installed via homebrew:

brew install git-lfs

On OSX, install python3 via homebrew:

brew install python3

Install virtualenv with pip:

pip install virtualenv

From the project directory, enter the following command:

virtualenv -p python3 venv

From the project directory, source venv/bin/activate

After activating the vm, make sure you have all of the necessary dependencies installed. Simply type:
pip install -r requirements.txt

1. From the project directory, type:
   python manage.py runserver
2. In your browser, navigate to http://localhost:8000

Use the following command to create a new admin user:

python manage.py createsuperuser

Install a new package:

pip install <some package name here>

Update requirements.txt:

pip freeze > requirements.txt

Be careful not to add unnecessary dependencies to requirements.txt

deactivate

This section describes our current apps.

You may view a sample of database entries at this url:

http://localhost:8000/uat/1/

Please develop your app on a branch:

If you wanted to make an app called analysis, branch off of master in the following way:

git checkout master git checkout -b analysis

Make your app and test it.

python manage.py startapp analysis

Create a simple README for your app (at APILWeb/analysis/README.md)

When you're ready, merge it into master:

git checkout master

Remember to pull!

git pull

Now merge:

git merge analysis

If the merge is successful (or you've resolved any conflicts), go ahead and push:

git push

Please update the "Active apps" section of the project README with a short description of your app.