Chore:

- Update README.md
- Update config to use postgresql
- Add .vscode/settings.json

.env

@@ -1,8 +0,0 @@
-# Domain
-# Will be set to the prod domain with an env var on deployment used by Traefik
-# to transmit traffic and acquire TLS certs
-ENVIRONMENT=local
-PROJECT_NAME="CMT"
-
-# DB URI
-DATABASE_URI=mysql+mysqldb://admin:Avatarme1@localhost:3306/CMT

.gitignore

@@ -1,2 +1,4 @@
 **/__pycache__
 **/.pytest_cache
+**/venv
+**/.env

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "github.copilot.advanced": {
+    "ignore": [
+      "**/.env",
+      "**/.env.*",
+      "**/secrets/**",
+      "**/*.key",
+      "**/*.pem"
+    ]
+  }
+}

README.md

@@ -1,12 +1,36 @@
 # CMT
+### Starting the application
+```bash
+cd backend
+fastapi run --reload app/main.py
+```
 ### DB
+MySQL
 ```sql
--- db setup
+-- MySQL db setup
 cat db_setup.sql | mysql -u root -p
 -- table setup
 cat db_table_setup.sql | mysql -u admin -p CMT
 ```
+Postgresql
+```bash
+# Installation - Arch
+sudo pacman -Syu postgresql
 
+# Initialising db cluster
+sudo -u postgres initdb -D /var/lib/postgres/data
+
+# enable + start service
+sudo systemctl enable --now postgresql
+
+# Creating user
+sudo -u postgres createuser -P appuser
+# Creating db owned by this user
+sudo -u postgres createdb -O appuser db_name
+
+# Test
+psql "postgresql://appuser:secret@localhost:5432/appdb"
+```
 ### Testing
 ```
 cd backend

backend/app/core/config.py

@@ -1,5 +1,5 @@
 from pydantic import (
-    MySQLDsn
+    PostgresDsn
 )
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
@@ -7,7 +7,7 @@ from pydantic_settings import BaseSettings, SettingsConfigDict
 class Settings(BaseSettings):
     """
     """
-    database_uri: MySQLDsn
+    database_uri: PostgresDsn
     environment: str
     project_name: str