Dev

Developer Guide

The whole project is tailored using Django. Strong knowledge of python and Django is necessary to start with the project.

Requirements

1. Suitable IDE (preferably VSCode or PyCharm)
2. Python
3. Git

Setting up process

1. Clone the project to your local system using this command in a terminal with git installed in your system.

git clone https://github.com/sharunrajeev/studentManagementSystem.git

2. Create a virtual environment using this command in a terminal.

python -m venv venv

3. Activate the virtual environment using this command in a terminal.

source venv/bin/activate

4. Install the requirements using this command in a terminal.

pip install -r requirements.txt

5. Install PostgreSQL locally for development. Go to PostgreSQL and download the latest version of the database.
6. Create a database and add all the required details like username, password, host, port into a .env file in the root directory.
7. Run the migrations using this command in a terminal.

python manage.py migrate

8. Run the server using this command in a terminal.

python manage.py runserver

9. Open the browser and navigate to http://localhost:8000/admin/ to log in to the admin panel.
10. Open the browser and navigate to http://localhost:8000/user to view the user URLs.
11. Open the browser and navigate to http://localhost:8000/admin/ to view the admin URLs.