calibre-web-companion/README.md

29 lines
605 B
Markdown
Raw Normal View History

2020-07-08 02:11:21 +00:00
# requirements
Django 3.0
# how to use:
2020-07-16 16:12:47 +00:00
EDIT `./CalibreWebCompanion/settings.json.bak`
Remove the `.bak` from `db.sqlite3.bak` and `settings.json.bak`
2020-07-08 16:22:37 +00:00
`./CalibreWebCompanion`
run `./manage.py runserver`
2020-07-08 02:11:21 +00:00
2020-07-11 17:56:22 +00:00
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
2020-07-16 16:12:47 +00:00
- [x] Cache
2020-07-11 17:56:22 +00:00
# TODO
2020-07-16 16:12:47 +00:00
- [ ] cache with vary headers
- [ ] localisation
- [ ] Beautifying template
2020-07-16 17:33:57 +00:00
- [ ] Setup email functionality
- [ ] Profiling with logging
- [ ] deploy
2020-07-16 16:12:47 +00:00
2020-07-11 17:56:22 +00:00