Start documentation work
This commit is contained in:
parent
ccbbbffe6f
commit
8258e5ab0a
1 changed files with 26 additions and 1 deletions
25
README.md
25
README.md
|
@ -1,3 +1,28 @@
|
|||
# nyxask
|
||||
|
||||
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
|
||||
```
|
Loading…
Add table
Reference in a new issue