From 8258e5ab0ae8317257cd1a511c7ddf3e3e7d1851 Mon Sep 17 00:00:00 2001 From: nyx Date: Wed, 12 Mar 2025 21:30:00 -0500 Subject: [PATCH] Start documentation work --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bb4cb0..e5d6b82 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ # nyxask -qna software thingy \ No newline at end of file +qna software thingy + +## Setup + +1. Create the database: +```sql +CREATE DATABASE nyxask WITH ENCODING = 'UTF8'; +CREATE USER nyxask WITH ENCRYPTED PASSWORD 'nyxask'; +GRANT ALL PRIVILEGES ON DATABASE nyxask TO nyxask; +ALTER DATABASE nyxask OWNER TO nyxask; +\q +``` +2. Create the venv: +```shell +python -m venv ./.venv +``` + +3. Install requirements: +```shell +pip install -r requirements.txt +``` + +4. Run the app: +```shell +python app/app.py +``` \ No newline at end of file