diff options
author | Matthew Lemon <y@yulqen.org> | 2024-05-30 14:37:54 +0100 |
---|---|---|
committer | Matthew Lemon <y@yulqen.org> | 2024-05-30 14:37:54 +0100 |
commit | f307232ebf2a623bf07873a411af5c549b25f76f (patch) | |
tree | c2ad40def5a835b75202a23b7e9cfdd27353039d /README.md | |
parent | 8e4381daeba028f4f6069566a78a22f1add57eda (diff) |
Got rid of the cookiecutter README guff
- Replaced with a nice set of requirements
- Sets out user definitions
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 123 |
1 files changed, 26 insertions, 97 deletions
@@ -1,97 +1,26 @@ -# pyblackbird-cc - -Joanna Lemon Resources - -[![Built with Cookiecutter Django](https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter)](https://github.com/cookiecutter/cookiecutter-django/) -[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) - -License: GPLv3 - -## Settings - -Moved to [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 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 pyblackbird_cc - -### 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 pyblackbird_cc -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 pyblackbird_cc -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 pyblackbird_cc -celery -A config.celery_app worker -B -l info -``` - -### Email Server - -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 [Mailpit](https://github.com/axllent/mailpit) with a web interface is available as docker container. - -Container mailpit will start automatically when you will run all docker containers. -Please check [cookiecutter-django Docker documentation](http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html) for more details how to start all containers. - -With Mailpit running, to view messages that are sent by your application, open your browser and go to `http://127.0.0.1:8025` - -### 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](http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html). +# Joanna Lemon Resources + +## Definition of users + +- **Admin**: Superuser, staff in Django terms. +- **Anonymous**: Someone browsing the site with zero credentials; not logged in. +- **Non-Subscriber**: Someone how has created an account and has logged in but is not yet subscribed. +- **Subscriber**: Someone who has a non-staff/superuser account on the site. +- **All**: All users. + +## Requirements + +- [x] Admin can create a new Resource via the user UI and the admin site +- [x] Admin can edit a Resource via the user UI and the admin site +- [ ] Admin can delete a Resource via the user UI and the admin site +- [x] Admin can log into the admin site +- [ ] All can view the Home page, advertising the services offered, including a Sample of resources and details of the subscription +- [x] All can view the Resource List page +- [x] All can view the Resource Detail page +- [ ] All can filter the Resource list page according to certain parameters +- [ ] Admin can create a new ResourceType, ResourceDescription and other entities, via the admin site +- [ ] All can view all pages of the Resource PDF via a carousel viewer +- [ ] Anonymous can sign up for an account to become a Non-Subscriber +- [ ] Anonymous will receive a verification email to validate their identity before Non-Subscriber status is created +- [ ] Non-Subscriber can reach a page offering them to become a Subscriber +- [ ] Non-Subscriber can submit a form to become a Subscriber |