Commitmonitor
Running
Setup
- On project root, do the following:
- Create a copy of
commitmonitor/settings/local.py.example
:
cp commitmonitor/settings/local.py.example commitmonitor/settings/local.py
(remembering you should replacecommitmonitor
with your project's name!). - Create a copy of
.env.example
:
cp .env.example .env
- Create the migrations for
users
app (do this, then remove this line from the README):
python manage.py makemigrations
- Run the migrations:
python manage.py migrate
Tools
- Setup editorconfig, prospector and ESLint in the text editor you will use to develop.
Running the project
- Open a command line window and go to the project's directory.
pipenv install --dev
npm install
npm run start
- Open another command line window and go to the project's directory.
pipenv shell
python manage.py runserver
Celery
- Open a command line window and go to the project's directory
pipenv shell
python manage.py celery
Testing
make test
Will run django tests using --keepdb
and --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
Just run pipenv install LIB_NAME_ON_PYPI
and then pipenv lock
to lock the version in Pipfile.lock file
Linting
- Manually with
prospector
andnpm run lint
on project root. - During development with an editor compatible with prospector and ESLint.
Pre-commit hooks
- Run
pre-commit install
to enable the hook into your git repo. The hook will run automatically for each commit. - Run
git commit -m "Your message" -n
to skip the hook if you need.
Contributing
django-admin startproject
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 fill-*
).
How to add a 'Deploy to Heroku' button
Read this.
P.S. if you want to deploy in a different way please check the app.json
file for what needs to be configured.
Commercial Support
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: contact@vinta.com.br
Copyright (c) 2018 Vinta Serviços e Soluções Tecnológicas Ltda. MIT License