This is the API backend for the November Project Tracker app.
The Tracker API uses Docker to have a consistent development environment.
Mac users can use Homebrew to install docker-machine, docker, and
docker-compose or visit the Docker installation documentation for more
information. Non-Mac users should also see the Docker installation
documentation for instructions regarding their development environment.
Once Docker is setup correctly, simply run docker-compose up to run the
project. This might take some time to run initially because Docker needs to
build the container images with all the dependencies needed for the project.
The API requires seed data for the tribes in the database before anything will
function properly. To add seed data, log into the Postgresql database using
docker-compose run web psql -U postgres. This will start the Docker container
and connect to the Postgresql database. You can then insert tribe data like
so:
INSERT INTO tribes VALUES (default, 'Boston, MA', '[1,3,5]', 42.358431, -71.059773, 'America/New_York');If you'd like to contribute, please look at the issues for things to do, or create your own issues and PRs for things you'd like fixed, improved, or added. Please follow the Contributing guide and Code of Conduct when contributing. Thank you, contributors!
If not otherwise specified (see below), files in this repository fall under the following license:
An exception is made for files in readable text which contain their own license information.