- On project root, do the following:
- Create a copy of
cp commitmonitor/settings/local.py.example commitmonitor/settings/local.py(remembering you should replace
commitmonitorwith your project's name!).
- Create a copy of
cp .env.example .env
- Create the migrations for
usersapp (do this, then remove this line from the README):
python manage.py makemigrations
- Run the migrations:
python manage.py migrate
Running the project
- Open a command line window and go to the project's directory.
pipenv install --dev
npm run start
- Open another command line window and go to the project's directory.
python manage.py runserver
- Open a command line window and go to the project's directory
python manage.py celery
Will run django tests using
--parallel. You may pass a path to the desired test module in the make command. E.g.:
make test someapp.tests.test_views
Adding new pypi libs
pipenv install LIB_NAME_ON_PYPI and then
pipenv lock to lock the version in Pipfile.lock file
- Manually with
npm run linton project root.
- During development with an editor compatible with prospector and ESLint.
pre-commit installto enable the hook into your git repo. The hook will run automatically for each commit.
git commit -m "Your message" -nto skip the hook if you need.
How to test
If you made changes to this boilerplate and want to test them, commit your changes and use
git archive -o boilerplate.zip HEAD to create the template zip. Then, do a
cd .. and a
django-admin startproject theprojectname --extension py,yml,json --name Procfile,README.md,.env.example --template=django-react-boilerplate/boilerplate.zip to test the project bootstrap.
How to test Heroku deployment
Push your changes to a branch and visit
https://dashboard.heroku.com/new?template=https://github.com/fill-org-or-user/fill-project-repo-name/tree/fill-branch (replace all
How to add a 'Deploy to Heroku' button
P.S. if you want to deploy in a different way please check the
app.json file for what needs to be configured.
This project, as other Vinta open-source projects, is used in products of Vinta clients. We are always looking for exciting work, so if you need any commercial support, feel free to get in touch: firstname.lastname@example.org
Copyright (c) 2018 Vinta Serviços e Soluções Tecnológicas Ltda. MIT License