From ebf03f1feb2abafcfee76dc1f26af77b179c673c Mon Sep 17 00:00:00 2001 From: Adil Mohak <60693922+adilmohak@users.noreply.github.com> Date: Thu, 4 Jan 2024 21:33:35 +0300 Subject: [PATCH 1/2] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 27fe6a1..6277027 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Feature-rich learning management system. Let's enhance the project by contributing! 👩‍💻👩‍💻 -- Demo video: https://youtu.be/KKIeRXwZ-Sw *Please note that the video does not feature the most recent UI design.* +- Demo video: https://youtu.be/KKIeRXwZ-Sw *Please note that the video does not showcase the latest updates on UI design and backend functionality.* - Setup video: https://youtu.be/gMJfENDEyUs ![Screenshot from 2023-12-31 17-36-31](https://github.com/adilmohak/django-lms/assets/60693922/e7fb628a-6275-4160-ae0f-ab27099ab3ca) @@ -56,12 +56,13 @@ Current features ```config DB_NAME=[YOUR_DB_NAME] DB_USER=[DB_ADMIN_NAME] -DB_PASSWORD=[DB_PASSWORD] +DB_PASSWORD=[DB_ADMIN_PASSWORD] DB_HOST=localhost -DB_PORT= +DB_PORT=[YOUR_POSTGRES_PORT default is 5432] USER_EMAIL=[YOUR_EMAIL] USER_PASSWORD=[EMAIL_PASSWORD] DEBUG=True +SECRET_KEY=[YOUR_SECRET_KEY] ``` - `python manage.py makemigrations` From 0906d9ec6ca7e16449466f62e84a0bbb2a4ccb74 Mon Sep 17 00:00:00 2001 From: Adil Mohak <60693922+adilmohak@users.noreply.github.com> Date: Thu, 4 Jan 2024 21:54:23 +0300 Subject: [PATCH 2/2] Update README.md --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6277027..0b0f92a 100644 --- a/README.md +++ b/README.md @@ -46,14 +46,21 @@ Current features # Installation -- Clone the repo with `git clone https://github.com/adilmohak/django-lms.git` +- Clone the repo with + +```bash +git clone https://github.com/adilmohak/django-lms.git +``` - Create and activate a python virtual environment -- `pip install -r requirements.txt` +```bash +pip install -r requirements.txt +``` - Create `.env` file inside the root directory and include the following variables -```config + +```bash DB_NAME=[YOUR_DB_NAME] DB_USER=[DB_ADMIN_NAME] DB_PASSWORD=[DB_ADMIN_PASSWORD] @@ -65,11 +72,17 @@ DEBUG=True SECRET_KEY=[YOUR_SECRET_KEY] ``` -- `python manage.py makemigrations` +```bash +python manage.py makemigrations +``` -- `python manage.py migrate` +```bash +python manage.py migrate +``` -- `python manage.py runserver` +```bash +python manage.py runserver +``` Last but not least, go to this address http://127.0.0.1:8000