A Django site for managing my fanfiction reading list.
This project uses:
- Python 3.10
- Django 4.1
Copy env.template to a local .env file
cp env.template .env
Will generate a set of sample Fandom, Author, Character, Tag, and Ship objects, then use those objects to generate 100 Fic objects.
Does not necessarily add every Character in a Ship; it's expected that you do your own massaging of the data via the CLI or (coming soon) the Django admin if you need perfect sample data.
./manage.py load_sample_fics
I use just to help standardize working with
this project. If you don't have it installed, for MacOS, run brew install just.
Runs git checkout main.
Runs pytest generating an HTML coverage report and opens it in your local browser.
Same as above but with python manage.py shell added, so you can start trying Django things more easily.
Runs black . to format the codebase.
Runs the corresponding Django command in the web container.
Runs git pull origin main.
Removes the web container, then rebuilds web.
This should be used after each just pip-compile, as the project dependencies should have changed.
Runs docker-compose up
Provides a bash prompt insided the web container. Useful for debugging and manual testing/investigation.
Runs pytest and interrogate in the web container. Please: write, run, and document your tests.
Runs the command to generate new output CSS files for Tailwind.
tailwindcss -i ./static/src/main.css -o ./static/src/output.css --minify