Update docs

lulunac27a · Jan 4, 2025 · 4f08b98 · 4f08b98
1 parent 71252c0
commit 4f08b98
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,11 @@ This app is an endless user-based level and XP (experience points). It uses SQli
 
 ### Getting Started
 
-1. Clone the repository
-2. Install the requirements: `pip install -r requirements.txt`
-3. Run the app: `python app.py`
-4. Go to `localhost:8081` on your web browser
+1. Clone the repository.
+2. Install the requirements: `pip install -r requirements.txt`.
+3. Run the app: `python app.py`.
+4. Create a migration using `flask db init`.
+5. Create a migration script using `flask db migrate`.
+6. Apply the migration using `flask db upgrade`.
+7. Run the app using `flask run`.
+8. Open `localhost:8081` on your web browser.
diff --git a/docs/index.md b/docs/index.md
@@ -4,7 +4,11 @@ This app is an endless user-based level and XP (experience points). It uses SQli
 
 ### Getting Started
 
-1. Clone the repository
-2. Install the requirements: `pip install -r requirements.txt`
-3. Run the app: `python app.py`
-4. Go to `localhost:8081` on your web browser
+1. Clone the repository.
+2. Install the requirements: `pip install -r requirements.txt`.
+3. Run the app: `python app.py`.
+4. Create a migration using `flask db init`.
+5. Create a migration script using `flask db migrate`.
+6. Apply the migration using `flask db upgrade`.
+7. Run the app using `flask run`.
+8. Open `localhost:8081` on your web browser.