updated readme a bit

Author: barreraalexander

.env.dist

@@ -1,8 +1,9 @@
-DATABASE_HOSTNAME=localhostfornow
+DATABASE_HOSTNAME=localhost
 DATABASE_PORT=5432
-DATABASE_PASSWORD=mypassword
-DATABASE_NAME=mydbname
-DATABASE_USERNAME=probablyroot
-SECRET_KEY=000secretkey000
-ALGORITHM=SOMEALGORITHM
-ACCESS_TOKEN_EXPIRE_MINUTES=300
+DATABASE_PASSWORD=somepassword
+DATABASE_NAME=somedbname
+DATABASE_USERNAME=mayberoot
+SECRET_KEY=thisisasecret
+ALGORITHM=HS256
+ACCESS_TOKEN_EXPIRE_MINUTES=30
+DEBUGGING=1

README.md

@@ -51,7 +51,9 @@ Open-source starter powered by FastAPI on top of **[Soft UI Dashboard](https://g
    1. create a virtual environment with the following command (always without the quotes): `python -m venv venv`
    2. activate the virtual environment, for linux/ubuntu: `source/bin/activate`, for windows `source/Scripts/activate`
    3. install the dependencies: `pip install -r requirements.txt`
-   4. run the application `uvicorn src.app:app --reload`
+   4. create a `.env` file, then copy and paste-in the contents of `.env.dist`, and fill in the configuration with your credentials.
+      > setting the `debugging` config to `1` will start the app with sqlite, setting it to `0` will start the app with mysql.  
+   5. run the application: `uvicorn src.app:app --reload`
 
 @ToDo
 

src/config.py

@@ -8,7 +8,6 @@ class Settings(BaseSettings):
     database_username: str
     secret_key: str
     algorithm: str
-    debugging: int
     access_token_expire_minutes: int = 30
 
     class Config: