calibre-web-companion/README.md
MassiveAtoms 10648a6d0a Revert "clarification readme"
This reverts commit e62e54757a.
2020-07-31 17:07:30 -03:00

29 lines
605 B
Markdown

# requirements
Django 3.0
# how to use:
EDIT `./CalibreWebCompanion/settings.json.bak`
Remove the `.bak` from `db.sqlite3.bak` and `settings.json.bak`
`./CalibreWebCompanion`
run `./manage.py runserver`
this is in development mode. don't actually use it or release it like this. The debug info it shows is spicy.
# Features
- [x] Books
- [x] navbar with tags, series, authors, etc
- [x] Search
- [x] authentication
- [x] Cache
# TODO
- [ ] cache with vary headers
- [ ] localisation
- [ ] Beautifying template
- [ ] Setup email functionality
- [ ] Profiling with logging
- [ ] deploy