Go to file
Daniel Egger 20a142add2 Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.envs/.local Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
compose Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
config Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
docs Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
locale Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
requirements Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
vbv_lernwelt Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.dockerignore Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.editorconfig Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.gitattributes Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.gitignore Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.pre-commit-config.yaml Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.pylintrc Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
.readthedocs.yml Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
README.md Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
gulpfile.js Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
local.yml Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
manage.py Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
merge_production_dotenvs_in_dotenv.py Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
package.json Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
production.yml Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
pytest.ini Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00
setup.cfg Initial commit after cookiecutter 2022-02-02 09:10:21 +01:00

README.md

VBV Lernwelt

Behold My Awesome Project!

Built with Cookiecutter Django Black code style

Settings

Moved to settings.

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, use this command:

    $ python manage.py createsuperuser
    

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.

Type checks

Running type checks with mypy:

$ mypy vbv_lernwelt

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 pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation.