Update README.md

This commit is contained in:
2025-04-16 16:04:09 +02:00
parent a573646ffb
commit 5fe48d793c

View File

@@ -1,33 +1,72 @@
# How to install
## Setting up your virtual environment # Installation Guide
### Creating virtual environment
## Setting Up Your Virtual Environment
### 1. Create a Virtual Environment
To begin, create a virtual environment using the following command:
```bash
python -m venv venv python -m venv venv
```
### Activating environment for package installation (windows) ### 2. Activate the Virtual Environment
.\venv\Scripts\activate.bat For Windows, activate the virtual environment with:
```bash
. env\Scriptsctivate.bat
```
### Installing required packages ### 3. Install Required Packages
Once the environment is activated, install the necessary packages by running:
```bash
pip install -r requirements.txt pip install -r requirements.txt
```
## Setting up the database ---
### Initialize database
## Setting Up the Database
### 1. Initialize the Database
To initialize the database, run the following command:
```bash
flask --app app.py db init flask --app app.py db init
```
### Migrate database ### 2. Migrate the Database
Migrate the database schema to the latest version with:
```bash
flask --app app.py db migrate flask --app app.py db migrate
```
### upgrade database ### 3. Upgrade the Database
Apply the migration to update the database with:
```bash
flask --app app.py db upgrade flask --app app.py db upgrade
```
## Seeding the database ---
Run seed.py to seed the database with a few users and services
## Starting application ## Seeding the Database
Run app.py to run the application To populate the database with a few sample users and services, run:
```bash
python seed.py
```
---
## Starting the Application
To start the application, run:
```bash
python app.py
```
---
# Development commands # Development Commands
#### Updating requirements.txt
### Updating `requirements.txt`
To update the `requirements.txt` with the currently installed packages, use the following command:
```bash
pip freeze > requirements.txt pip freeze > requirements.txt
```
---