Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
BobsProgrammingAcademy authored Jul 21, 2024
1 parent 01313e7 commit 54a59b1
Showing 1 changed file with 11 additions and 18 deletions.
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -13,27 +12,25 @@ 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:

1. [Python 3.8-3.11](https://www.python.org/downloads/)
<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).
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:

```bash
python -m venv venv
```

#### 2. Activate the virtual environment
### 2. Activate the virtual environment

From the **root** directory, run:

Expand All @@ -49,15 +46,15 @@ On Windows:
venv\scripts\activate
```

#### 3. Install required dependencies
### 3. Install required dependencies

From the **root** directory, run:

```bash
pip install -r requirements.txt
```

#### 4. Run migrations
### 4. Run migrations

From the **root** directory, run:

Expand All @@ -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:

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

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


### Run the application
## Run the application

From the **root** directory, run:

```bash
python manage.py runserver
```


### Run the tests
## Run the tests

From the **root** directory, run:

Expand All @@ -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.

0 comments on commit 54a59b1

Please sign in to comment.