Newsletter-Application
License : MIT
In order to run locally you need docker-compose to build the docker containers:
docker-compose -f local.yml up --build
1- Make sure that you've installed the following services locally or have access to them: 1-1: Local smtp server listening on port 1025. 1-2: Redis server
1- Create a .env file at the root folder of your directory. Add the following settings to the file and modify them to meet your local configurations:
DEBUG=False
DATABASE_URL=sqlite://./db.sqlite
CELERY_BROKER_URL=redis://localhost:6379/0
USE_DOCKER=False
EMAIL_HOST=127.0.0.1
2- Build/run the application executing the following commands:
$ make venv
$ source venv/bin/activate
$ make install_local
$ export DJANGO_READ_DOT_ENV_FILE=True
$ make build
$ make server
After running your local/production server, a swagger UI documentation of endpoints is installed on api/docs/ endpoint.
Moved to settings.
-
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.
Running type checks with mypy:
$ mypy newzila
To run the tests, check your test coverage, and generate an HTML coverage report:
$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html
$ pytest
Moved to Live reloading and SASS compilation.
This app comes with Celery.
To run a celery worker:
cd newzila
celery -A config.celery_app worker -l info
Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.
In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.
Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation for more details how to start all containers.
With MailHog running, to view messages that are sent by your
application, open your browser and go to http://127.0.0.1:8025
The following details how to deploy this application.
See detailed cookiecutter-django Docker documentation.