University Project With Django And React

This project consists of four team members overall devided into two teams of two in frontend and backend. We will use Django to provide apis for reaching out to business logic and database and also use reactjs library for client side. In Bellow and up comming parts of this readme file you will find pre requests to run projects in client and server side , All models , use cases and methods used in project.

Prerequisites

• Node.js (version X.X.X)
• Npm (version X.X.X)
• Django (version Y.Y.Y)

Getting Started

Preparing the backend side

a) Clone the repository

git clone  https://github.com/pooya-dehghan/educational_ministry_irp

b) Navigate to the project directory:

cd educational_ministry_irp

c) Create a virtual environment to isolate project dependencies locally

python -m venv <name of your virtualenv>
example:
python -m venv my_env

• we can install virtualenv package to create it too. use this command

python -m pip install virtualenv

• after installing virtualenv use this command for creating your virtual environment

virtualenv <name of your environment>
example:
virtualenv my_env

d) activate your virtual environment

• windows

<name of your environment>\Scripts\activate
example:
my_env\Scripts\activate

• linux:

source <name of your environment>/bin/activate
example:
source my_env/bin/activate

e) Install the dependencies(Backend side)

• notice that your virtual environment should be active while installing
• using backend_requirments.txt file in the repo:

pip install -r backend_requirments.txt

f) navigate to the backend folder(directory)

cd backend

g) now you can run the backend server with this command:

python manage.py runserver

h) If you want to see the output, open the browser and search for this address

http://localhost:8000
or
http://127.0.0.1:8000

migrate

you have more than 20 unapplied migrations. so you can not use the admin panel or database.

• this command applies all unapplied migrations.

python manage.py migrate

superuser

• To access the admin panel to manage users and materials, create a superuser:

python manage.py createsuperuser

• Follow the prompts to enter your desired username, email, and password.

• Go to http://localhost:8000/admin/ ↗ and log in with your superuser credentials.

Install the dependencies of client side and run it:

a) first we should download node.js to our system from it's website: https://nodejs.org/en/download/

b) then we should install it from it's setup wizard.

c) to make sure of installing node, open cmd and write this command below. this shows you the version of node that installed on your system.

node -v

d) by installing node.js , npm ( node package manager) is being installed on your system automatically. write this command below to make sure.

npm -v

e) now we should install the required modules to our project. first go to frontend directory on cmd

cd frontend

then write this command :

npm install

f)now open the vscode. open a new terminal. change directory to frontend. write this command below. this gives you a vite port and a local link address.

npm run dev

Access the API at http://localhost:XXXX/XXXX/XXXX

Backend Views

As a back-end developer, here are some of the key views and endpoints that you'll want to be aware of:

• school/api/v1/list/: This endpoint returns a list of all schools in the system.

• school/api/v1/int:pk/: This endpoint use for create update and delete a school in the system.

• student/api/v1/list/: This endpoint returns a list of all students in the system.

• student/api/v1/int:pk/: This endpoint use for create update and delete a student in the system.

• accounts/api/v1/registration/: endpoint for user registration.

• accounts/api/v1/jwt/create/ endpoint is typically used for creating access and refresh token

• /accounts/api/v1/jwt/refresh/ endpoint is used for refreshing user access tokens

• accounts/api/v1/jwt/verify/ endpoint is used for validating user tokens.

• accounts/api/v1/login/ : this endpoint is for login :))))

Authentication

This API uses token-based authentication. To access protected endpoints, include an Authorization header in your requests with the value Bearer YOUR_TOKEN.

Features

User Authentication:

• User registration {done}
• User login {done}
• User logout {done}
• Password reset/forgot password {done}

User: All kind of user Profile:

• Retrieve user profile {done}
• Update user profile (name, bio, profile picture) {done}
• user requesting to specific Office Manager or some other user for specific roles
• Getting notifications
• making notification for specific user
• read/seen notifications
• Deleting Profile
• Updating Profile

Super User

• Crud on every thing
• List and Get every thing
• Manage roles

University Student

• Request to office manager
• Get and List region
• Generate report of School and manager performance
• Generate report of teacher
• mashghasham benviseh :)
• school request status
• List Attendance
• List Grade of report and attendance

Office manager

• CRUD on schools
• School assignment
• List and get Schools and their managers
• generate reports or analytics on student performance

Teacher

• Generate report on student performance
• grade assignment

Professor

• List Student information
• Get student information(All reports, All Attendance‏s, All assignments, Personal info, School info)
• List student's report
• Grade student report
• Generate report for student performance

School Manager

• CRUD on teacher

• Registeration Capacity

• Grade student performance

• Fill Attendance‏

• Get and List own teachers and own students

  Notifications:

• List profile template for admin

• sending notification for specific route

• getting notification for specific user

i use 3 code 301 means you have a request from student for assign to school 401 means your request rejected from office_manager and 501 means your request accepted and you assigned to one school

Report

• CRUD
• Generate PDF
• List and Get

Assignment

• Generate PDF

Attendance‏

• Generate PDF/CSV

Request

• CRUD

Models

interface User {
id : number
username : String
national_code : String
phone_number : String
email : EmailField
first_name : String
last_name : String
birthday_date : DateTimeField
gender : String
is_active : BooleanField
created_date : DateTimeField
updated_date : DateTimeField
avatar: ImageField
is_admin: BooleanField
personal_code : String
}

interface Teacher {
id : number
username : String
national_code : String
phone_number : String
email : EmailField
first_name : String
last_name : String
birthday_date : DateTimeField
gender : String
is_active : BooleanField
created_date : DateTimeField
updated_date : DateTimeField
avatar: ImageField
is_admin: BooleanField
personal_code : String
field : String
slug: SlugField
Level_of_education: String
}

interface OfficeManager {
id : number
username : String
national_code : String
phone_number : String
email : EmailField
first_name : String
last_name : String
birthday_date : DateTimeField
gender : String
is_active : BooleanField
created_date : DateTimeField
updated_date : DateTimeField
avatar: ImageField
is_admin: BooleanField
personal_code : String
region: Number
}

interface School {
id : number
username : String
national_code : String
phone_number : String
email : EmailField
first_name : String
last_name : String
birthday_date : DateTimeField
gender : String
is_active : BooleanField
created_date : DateTimeField
updated_date : DateTimeField
avatar: ImageField
is_admin: BooleanField
personal_code : String
name : String
slug: SlugField
established_year: Number
created: DateTimeField
updated: DateTimeField
city: String
region: Number
capacity: Number
manager: String
title: String
teacher: Teacher
office_manager: OfficeManager
}

interface Professor {
id : number
username : String
national_code : String
phone_number : String
email : EmailField
first_name : String
last_name : String
birthday_date : DateTimeField
gender : String
is_active : BooleanField
created_date : DateTimeField
updated_date : DateTimeField
avatar: ImageField
is_admin: BooleanField
personal_code : String
professor_id : String
is_science_committee: BooleanField
}

interface Student {
id : number
username : String
national_code : String
phone_number : String
email : EmailField
first_name : String
last_name : String
birthday_date : DateTimeField
gender : String
is_active : BooleanField
created_date : DateTimeField
updated_date : DateTimeField
avatar: ImageField
is_admin: BooleanField
personal_code : String
student_id: String
field: String
professor: Professor
school: School
teacher: Teacher
}

interface StudentActivity {
id: Number
title: String
slug: SlugField
created: DateTimeField
updated: DateTimeField
content: String
student: Student
is_done: BooleanField
}

interface Report {
id : Number
name : String
student : Student
professor : Professor
report_file : File
created : DateTimeField
updated : DateTimeField
}

interface Request {
id : Number
sender : Student
reciever : OfficeManager
created : DateTimeField
updated : DateTimeField
status : String
}

interface Attendance {
id : Number
student : Student
school : School
school_manager : String
teacher : Teacher
is_present : BooleanField
date : DateField
enterance_time : TimeField
exit_time : TimeField
created : DateTimeField
updated : DateTimeField
}

API routes and documentation are available on under domain .../swagger

Contributing

Contributions are welcome! If you find any issues or would like to add new features, feel free to open a pull request.

License

This project is licensed under the GPL-3.0 License.

Copyright 2023, Pooya Dehghan