You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
1 year ago | |
---|---|---|
.github | 2 years ago | |
.idea | 1 year ago | |
chat | 1 year ago | |
config | 1 year ago | |
docs | 1 year ago | |
locale | 2 years ago | |
requirements | 1 year ago | |
utility | 2 years ago | |
.editorconfig | 2 years ago | |
.env | 2 years ago | |
.eslintrc.js | 1 year ago | |
.gitattributes | 2 years ago | |
.gitignore | 1 year ago | |
.pre-commit-config.yaml | 2 years ago | |
.pylintrc | 1 year ago | |
.readthedocs.yml | 2 years ago | |
CONTRIBUTORS.txt | 2 years ago | |
COPYING | 2 years ago | |
LICENSE | 2 years ago | |
Makefile | 1 year ago | |
README.rst | 1 year ago | |
gulpfile.js | 1 year ago | |
manage.py | 2 years ago | |
models.png | 1 year ago | |
package-lock.json | 2 years ago | |
package.json | 2 years ago | |
pyproject.toml | 2 years ago | |
pytest.ini | 2 years ago | |
setup.cfg | 2 years ago | |
yarn.lock | 2 years ago |
README.rst
Chat ==== Behold My Awesome Project! .. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter :target: https://github.com/pydanny/cookiecutter-django/ :alt: Built with Cookiecutter Django .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black :alt: Black code style :License: GPLv3 Settings -------- Moved to settings_. .. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html Basic Commands -------------- Setting Up Your Users ^^^^^^^^^^^^^^^^^^^^^ * To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go. * To create an **superuser account**, create a normal user account then change `is_staff` and `is_superuser` manually in database. For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users. Style/lint checks ^^^^^^^^^^^ Running type checking and linter with: :: $ make style Test coverage ^^^^^^^^^^^^^ To run the tests, check your test coverage, and generate an HTML coverage report:: $ coverage run -m pytest $ coverage html $ open htmlcov/index.html Running tests with py.test ~~~~~~~~~~~~~~~~~~~~~~~~~~ :: $ pytest Live reloading and Sass CSS compilation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Moved to `Live reloading and SASS compilation`_. .. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html Deployment ---------- The following details how to deploy this application.