2020-07-08 02:11:21 +00:00
|
|
|
# requirements
|
|
|
|
|
Django 3.0
|
|
|
|
|
|
|
|
|
|
# how to use:
|
2020-07-17 04:39:00 +00:00
|
|
|
EDIT `./CalibreWebCompanion/settings.json.bak`
|
|
|
|
|
Remove the `.bak` from `db.sqlite3.bak` and `settings.json.bak`
|
|
|
|
|
`./CalibreWebCompanion`
|
|
|
|
|
run `./manage.py runserver`
|
|
|
|
|
|
|
|
|
|
# Profiling
|
|
|
|
|
|
|
|
|
|
To do profiling, you have to create some dummy users
|
|
|
|
|
Unbakify a file `./loadtesting/dummyusers.json.bak` and fill in the credentials for the dummy users
|
|
|
|
|
|
|
|
|
|
While django is running, open another shell and cd to `./loadtesting` and run `./bench.py`
|
|
|
|
|
To have a more interactive session,
|
|
|
|
|
comment out
|
|
|
|
|
```
|
|
|
|
|
run-time = 2m
|
|
|
|
|
headless = true
|
|
|
|
|
```
|
|
|
|
|
in `locust.conf`, and then run `./bench.py`
|
|
|
|
|
You can then go to [http://localhost:8089/](http://localhost:8089/) to see live graphs, tweak the number of users and more.
|
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-17 04:39:00 +00:00
|
|
|
- [x] Profiling with logging
|
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
|
2020-07-17 04:39:00 +00:00
|
|
|
|
2020-07-16 17:33:57 +00:00
|
|
|
- [ ] deploy
|
2020-07-16 16:12:47 +00:00
|
|
|
|
2020-07-11 17:56:22 +00:00
|
|
|
|
|
|
|
|
|
