Skip to content

Commit 54a59b1

Browse files
Updated README
1 parent 01313e7 commit 54a59b1

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ This is a student management system built using **Django 4**, **HTML 5**, **CSS
44

55
![plot](https://github.com/BobsProgrammingAcademy/Student-Management-System/blob/master/students/static/images/homepage.png?raw=true)
66

7-
87
## Table of Contents
98
- [Prerequisites](#prerequisites)
109
- [Installation](#installation)
@@ -13,27 +12,25 @@ This is a student management system built using **Django 4**, **HTML 5**, **CSS
1312
- [View the application](#view-the-application)
1413
- [Copyright and License](#copyright-and-license)
1514

16-
17-
### Prerequisites
15+
## Prerequisites
1816

1917
Install the following prerequisites:
2018

2119
1. [Python 3.8-3.11](https://www.python.org/downloads/)
2220
<br> 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).
2321
2. [Visual Studio Code](https://code.visualstudio.com/download)
2422

23+
## Installation
2524

26-
### Installation
27-
28-
#### 1. Create a virtual environment
25+
### 1. Create a virtual environment
2926

3027
From the **root** directory, run:
3128

3229
```bash
3330
python -m venv venv
3431
```
3532

36-
#### 2. Activate the virtual environment
33+
### 2. Activate the virtual environment
3734

3835
From the **root** directory, run:
3936

@@ -49,15 +46,15 @@ On Windows:
4946
venv\scripts\activate
5047
```
5148

52-
#### 3. Install required dependencies
49+
### 3. Install required dependencies
5350

5451
From the **root** directory, run:
5552

5653
```bash
5754
pip install -r requirements.txt
5855
```
5956

60-
#### 4. Run migrations
57+
### 4. Run migrations
6158

6259
From the **root** directory, run:
6360

@@ -68,7 +65,7 @@ python manage.py makemigrations
6865
python manage.py migrate
6966
```
7067

71-
#### 5. Create an admin user to access the Django Admin interface
68+
### 5. Create an admin user to access the Django Admin interface
7269

7370
From the **root** directory, run:
7471

@@ -78,17 +75,15 @@ python manage.py createsuperuser
7875

7976
When prompted, enter a username, email, and password.
8077

81-
82-
### Run the application
78+
## Run the application
8379

8480
From the **root** directory, run:
8581

8682
```bash
8783
python manage.py runserver
8884
```
8985

90-
91-
### Run the tests
86+
## Run the tests
9287

9388
From the **root** directory, run:
9489

@@ -97,12 +92,10 @@ python manage.py test --pattern="tests.py"
9792

9893
```
9994

100-
101-
### View the application
95+
## View the application
10296

10397
Go to http://127.0.0.1:8000/ to view the application.
10498

105-
106-
### Copyright and License
99+
## Copyright and License
107100

108101
Copyright © 2022 Bob's Programming Academy. Code released under the MIT license.

0 commit comments

Comments
 (0)