aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..1171c25 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,26 @@
+# SEU Bookstore
+
+## Development
+
+```shell
+$ uv sync
+# Just like how any normal Django app
+$ uv run manage.py migrate # to create db
+$ uv run manage.py runserver
+```
+
+## Deployment
+
+```shell
+$ uv add gunicorn
+# Also add settings.py:ALLOWED_HOSTS
+$ uv run gunicorn bookstore_project.wsgi:application
+```
+
+## Default credentials
+
+Check out `store/migrations/0002_create_superuser.py` for details.
+
+## Import samples
+
+`*.jsonl` are samples pulled from [Anna's Archive](https://annas-archive.li/faq) and can be imported under staff/superuser priviledge (`/book/import/`). \ No newline at end of file