Release 15 - Revamp #38

Merged
ChaoticByte merged 27 commits from devel into main 2023-03-26 11:09:31 +00:00
2 changed files with 37 additions and 17 deletions
Showing only changes of commit 159e1cef7d - Show all commits

View file

@ -1,15 +1,15 @@
# Drinks Manager (season 2)
# Drinks Manager (Season 3)
Note: This software is tailored to my own needs.
I probably won't accept feature requests, and don't recommend you
to use this software if this isn't exactly what you are looking for.
Can't keep track of the number of drinks your guests drink?
Now you have a web interface that *really tries* to make things less complicated- for
you and your guests.
Now you have a web interface that *really tries* to make things
less complicated- for you and your guests.
This (exaggeration intended) most incredible piece of software is written in Python,
HTML, CSS, JS, Bash and uses Django and PostgreSQL.
This (exaggeration intended) most incredible piece of software is
written in Python, HTML, CSS, JS, Bash and uses Django and PostgreSQL.
You have to bring your own PostgreSQL Database though.
# Getting started
@ -26,30 +26,50 @@ Beneath a `PostgreSQL` DBMS, you need the following things:
- `pip`
- `Python` header files (RHEL: `python3-devel`, Ubuntu: `python3-dev`)
## Database
This project is using PostgreSQL. After creating a
user and database for this application, make shure to
```sql
revoke all on schema public from PUBLIC;
```
and revoke/grant other privileges accordingly to secure the
database against public access.
## Configuration
Create the configuration file by copying `./data/config.example.yml`
to `./data/config.yml`, and modify it for your needs.
## Create Environment & Install dependencies
Run the following from the main directory:
```
./scripts/setup-env.sh
```
## Activate Venv
## Create admin account
```
./scripts/create-admin.sh
```
This also runs all necessary migrations.
**On every new session**, before running commands with manage.py or developing, you have to activate the venv:
# Activate venv
**On every new session**, before running commands with
manage.py or developing, you have to activate the venv:
```
source ./venv/bin/activate
```
If you see `(venv)` before your command prompt, it worked!
##
# Configuration
see [Configuration](docs/Configuration.md)
# Usage
...
To start the Application and Webserver, run
```
./start.sh
```
or
```
./start.sh --devel
```

View file

@ -1,7 +1,7 @@
---
app:
# The secret key, used for security protections
# This MUST be a secret, very long, random string
# This MUST be a secret, very long (40+ characters), random string
secret_key: "!!!insert random data!!!"
# The port for the asgi application
# This should be blocked by the firewall