Completely re-structured the project from scratch, wrote a better bootstrap script, changed configuration format to yaml, improved Caddyfile, and more. #15 #16 #20
This commit is contained in:
parent
0012214f9b
commit
5572fec9c1
91 changed files with 739 additions and 1345 deletions
42
README.md
42
README.md
|
@ -12,20 +12,44 @@ This (exaggeration intended) most incredible piece of software is written in Pyt
|
|||
HTML, CSS, JS, Bash and uses Django and PostgreSQL.
|
||||
You have to bring your own PostgreSQL Database though.
|
||||
|
||||
# Getting started
|
||||
|
||||
## Setup, Installation, Updating and Dependencies
|
||||
## System Requirements
|
||||
|
||||
You can find the latest releases [here](https://gitlab.com/W13R/drinks-manager/-/releases), but you should consider using Git to easily switch between versions.
|
||||
For more information see [Setup](docs/Setup.md).
|
||||
Beneath a `PostgreSQL` DBMS, you need the following things:
|
||||
|
||||
- `pg_config` (Ubuntu: `libpq-dev`, RHEL: `libpq-devel`)
|
||||
- `Caddy` 2.4.3+ (HTTP Reverse Proxy & Static File Server)
|
||||
- `gcc`, `gettext`
|
||||
- `Python` 3.9+
|
||||
- `venv`
|
||||
- `pip`
|
||||
- `Python` header files (RHEL: `python3-devel`, Ubuntu: `python3-dev`)
|
||||
|
||||
## Configuration
|
||||
## Create Environment & Install dependencies
|
||||
|
||||
Run the following from the main directory:
|
||||
|
||||
```
|
||||
./scripts/setup-env.sh
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
## Usage
|
||||
|
||||
After setup, run ```./run.sh help``` to see a help text.
|
||||
Start the production server with ```./run.sh server```. You can ignore the error message about the "lifespan error".
|
||||
For more commands, see [Commands](docs/Commands.md).
|
||||
...
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue