Events 🎊

Settings

Moved to settings.

Basic Commands

setup the development environment

1. Install docker on you platform.
2. Install docker-compose on your platform.
3. Run the Development environment:

    git clone https://github.com/ahmedelfateh/event_app.git
    cd event_app
    docker-compose up --build

4. Open another terminal tab, to migrate DB:

    docker-compose run --rm django ./manage.py migrate

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, your login done.
• To create an superuser account, start in the root folder and use this command:

    docker-compose run --rm django ./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.

• To run any django command inside the docker environment, start in the root folder and use this command:

    docker-compose run --rm django ./manage.py **...django_command...**
    docker-compose run --rm django ./manage.py makemigrations

Type checks

Running type checks with mypy:

    docker-compose run --rm django mypy app

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report::

    docker-compose run --rm django coverage run -m pytest
    docker-compose run --rm django coverage html
    open htmlcov/index.html

Testing

• Run tests, for all app:

    docker-compose run --rm django pytest

• Run test for specific app:

    docker-compose run --rm django pytest **...specify_app...**
    docker-compose run --rm django pytest app/users/tests

Access App

• you can access the App on Home
• you can access the App Admin on Admin

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.

Docker

See detailed cookiecutter-django Docker documentation.