From df78a5f3e8f843b2deafb1096a9cc8acbba33969 Mon Sep 17 00:00:00 2001 From: Harris Tzovanakis Date: Wed, 31 Jul 2024 09:09:09 +0200 Subject: [PATCH] global: update instructions to run the project --- README.md | 105 +++--------------------------------------------------- 1 file changed, 4 insertions(+), 101 deletions(-) diff --git a/README.md b/README.md index eb9c2ee9..d371562a 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,8 @@ -# backoffice +# INSPIRE Backoffice -Behold My Awesome Project! - -[![Built with Cookiecutter Django](https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter)](https://github.com/cookiecutter/cookiecutter-django/) -[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) - -License: MIT - -## Settings - -Moved to [settings](http://cookiecutter-django.readthedocs.io/en/latest/settings.html). - -## Quickstart - -1. `docker compose -f local.yml run -d` -2. Enter django container backoffice-local-django and execute the following commands - a. `python manage.py create_groups` to create author and curator group definitions in the db - b. `python manage.py createsuperuser` to create a super user -3. Navigate to http://localhost:8000/admin/authtoken/ login with the newly created user and assign a token to it -4. Set your user to be in the admin group in here http://localhost:8000/admin/users/user/ - -## 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 a **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 backoffice - -### 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](https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html#sass-compilation-live-reloading). - -### Celery - -This app comes with Celery. - -To run a celery worker: - -```bash -cd backoffice -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. - -To run [periodic tasks](https://docs.celeryq.dev/en/stable/userguide/periodic-tasks.html), you'll need to start the celery beat scheduler service. You can start it as a standalone process: - -```bash -cd backoffice -celery -A config.celery_app beat -``` - -or you can embed the beat service inside a worker with the `-B` option (not recommended for production use): - -```bash -cd backoffice -celery -A config.celery_app worker -B -l info -``` - -### Sentry - -Sentry is an error logging aggregator service. You can sign up for a free account at 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](http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html). - -### Setting up groups & persmissions - -To set up groups and permissions execute following command: +This repo consists of Airflow Dags and Django backoffice. To run it: ```bash -python manage.py create_groups +make run +make init ```