diff --git a/README.md b/README.md index 94b9885..2ede4aa 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,72 @@ -# How to install -## Setting up your virtual environment -### Creating virtual environment + +# Installation Guide + +## 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 +``` -### Activating environment for package installation (windows) -.\venv\Scripts\activate.bat +### 2. Activate the Virtual Environment +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 +``` -## 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 +``` -### Migrate database +### 2. Migrate the Database +Migrate the database schema to the latest version with: +```bash 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 +``` -## Seeding the database -Run seed.py to seed the database with a few users and services +--- -## Starting application -Run app.py to run the application +## Seeding the Database +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 -#### Updating requirements.txt -pip freeze > requirements.txt \ No newline at end of file +# Development Commands + +### Updating `requirements.txt` +To update the `requirements.txt` with the currently installed packages, use the following command: +```bash +pip freeze > requirements.txt +``` + +---