We, the community and staff, have been building a custom Django application to handle out many parts of our organization.
- Fork and clone this repository locally.
- Download and install Docker for Mac or Windows.
- Navigate into the project directory via terminal and run
docker-compose build
. - Create a new file names
.env
based on.env.sample
. Create values for any instances ofREPLACEME
. - Once complete, run
docker-compose up
. - Load up your browser and go to http://127.0.0.1:8000.
- When you are done, you can stop the project via
ctrl+c
Note: Docker for Mac requires OSX Yosemite 10.10.3 or above. Docker for Windows requires Microsoft Windows 10 Professional or Enterprise 64-bit. For previous versions download Docker Toolbox.
username: admin@sink.sendgrid.net
password: admin
username: guardian@sink.sendgrid.net
password: guardian
After the initial project setup, you will only need to run docker-compose up --build
.
To setup the main respository as upstream
, you can add a new remote called upstream
.
git remote add upstream https://github.com/coderdojochi/coderdojochi
To grab the latest code from the main repo (named upstream
), run the following.
git fetch upstream --prune
git checkout master
git merge upstream/master master
Create a new branch based off of upstream
's master
branch.
git fetch upsteam --prune
git checkout -b feature/a-good-name upsteam/master
git push -u origin feature/a-good-name
Pull requests are always welcome. Make sure your pull request does one task only. That is, if it's fixing a bug, the pull request fixes only that bug. If you're adding a feature, make sure the pull request adds that one feature, not multiple at once.
Follow the "Creating a new branch" step above. Be sure to always push to your origin
remote, not upstream
.
- Running a command on a Docker app in a new container.
docker-compose run --rm app <command>
Examples:
docker-compose run --rm app /bin/bash
docker-compose run --rm app pipenv lock
docker-compose run --rm app python manage.py makemigrations
docker-compose run --rm app python manage.py migrate
- Cleaning up the docker containers:
docker kill $(docker ps -q); docker-compose rm -f; docker volume rm $(docker volume ls -qf dangling=true);
- Rebuild docker containers after major changes:
docker-compose build