Merge branch 'Muritadhor' of https://github.com/hngprojects/hng_boile…

…rplate_python_fastapi_web into Muritadhor

README.md

@@ -20,3 +20,63 @@ FastAPI boilerplate
  python main.py
 ```
 
+## **DATABASE TEST SETUP**
+
+To set up the database, follow the following steps:
+
+**Cloning**
+- clone the repository using `git clone https://github.com/hngprojects/hng_boilerplate_python_fastapi_web`
+- `cd` into the directory hng_boilerplate_python_fastapi_web
+- switch branch using `git checkout Muritadhor`
+
+**Environment Setup**
+- run `pip install -r requrements.txt` to install dependencies
+- create a `.env` file in the root directory and copy the content of `.env.sample` and update it accordingly
+
+**Create your local database**
+```bash
+sudo -u root psql
+```
+```sql
+CREATE USER user WITH PASSWORD 'password';
+CREATE DATABASE hng_fast_api;
+GRANT ALL PRIVILEGES ON DATABASE hng_fast_api TO user;
+```
+
+**Migrate the database**
+```bash
+alembic revision --autogenerate -m "Initial migrate"
+alembic upgrade head
+```
+
+**create dummy data**
+```bash
+python3 db_test.py
+```
+This should run without any errors
+
+**Using the database in your route files:**
+
+make sure to add the following to your file
+
+```python
+from api.db.database import create_database, get_db
+from api.v1.models.user import User
+from api.v1.models.org import Organization
+from api.v1.models.profile import Profile
+from api.v1.models.product import Product
+
+create_database()
+db = next(get_db())
+```
+Then use the db for your queries
+
+example
+```python
+db.add(User(email="test@mail", username="testuser", password="testpass", first_name="John", last_name="Doe"))
+```
+
+
+**Adding tables and columns to models**
+
+After creating new tables, or adding new models. Make sure to run alembic revision --autogenerate -m "Migration messge"