From 54a59b169b03414f6aa012e50b51e7dd2d090757 Mon Sep 17 00:00:00 2001 From: Bob's Programming Academy <97769721+BobsProgrammingAcademy@users.noreply.github.com> Date: Sun, 21 Jul 2024 07:38:47 +0200 Subject: [PATCH] Updated README --- README.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 9ba3672..8ca13a1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ This is a student management system built using **Django 4**, **HTML 5**, **CSS ![plot](https://github.com/BobsProgrammingAcademy/Student-Management-System/blob/master/students/static/images/homepage.png?raw=true) - ## Table of Contents - [Prerequisites](#prerequisites) - [Installation](#installation) @@ -13,8 +12,7 @@ This is a student management system built using **Django 4**, **HTML 5**, **CSS - [View the application](#view-the-application) - [Copyright and License](#copyright-and-license) - -### Prerequisites +## Prerequisites Install the following prerequisites: @@ -22,10 +20,9 @@ Install the following prerequisites:
This project uses **Django v4.2.4**. For Django to work, you must install a correct version of Python on your machine. More information [here](https://django.readthedocs.io/en/stable/faq/install.html). 2. [Visual Studio Code](https://code.visualstudio.com/download) +## Installation -### Installation - -#### 1. Create a virtual environment +### 1. Create a virtual environment From the **root** directory, run: @@ -33,7 +30,7 @@ From the **root** directory, run: python -m venv venv ``` -#### 2. Activate the virtual environment +### 2. Activate the virtual environment From the **root** directory, run: @@ -49,7 +46,7 @@ On Windows: venv\scripts\activate ``` -#### 3. Install required dependencies +### 3. Install required dependencies From the **root** directory, run: @@ -57,7 +54,7 @@ From the **root** directory, run: pip install -r requirements.txt ``` -#### 4. Run migrations +### 4. Run migrations From the **root** directory, run: @@ -68,7 +65,7 @@ python manage.py makemigrations python manage.py migrate ``` -#### 5. Create an admin user to access the Django Admin interface +### 5. Create an admin user to access the Django Admin interface From the **root** directory, run: @@ -78,8 +75,7 @@ python manage.py createsuperuser When prompted, enter a username, email, and password. - -### Run the application +## Run the application From the **root** directory, run: @@ -87,8 +83,7 @@ From the **root** directory, run: python manage.py runserver ``` - -### Run the tests +## Run the tests From the **root** directory, run: @@ -97,12 +92,10 @@ python manage.py test --pattern="tests.py" ``` - -### View the application +## View the application Go to http://127.0.0.1:8000/ to view the application. - -### Copyright and License +## Copyright and License Copyright © 2022 Bob's Programming Academy. Code released under the MIT license.