diff --git a/README.md b/README.md index 907cb6b..c9b2fde 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ # LMS-DB The schema code for the database and tables to be used by the LMS system + + +## Required Files +### ./.env +The environment variables file with the following variables: +``` +DB_NAME +DB_USER +DB_PASSWORD +``` + +## How to run +1) Create a virtual environment (Optional best practice) +```python +python -m venv +``` + +2) Acitvate the virtual environment +```bash +source /bin/activate +``` + +```cmd +\Scripts\activate.bat +``` + +2) Use Pip to install all required packages (Only required on first run) +```python +pip install -r requirements +``` + +3) Run the application +```python +python ./src/database_creation.py +``` \ No newline at end of file