Get Started
E-School Web App is a school management Application build to manage and digitalize all school activities and provide seamless payment integration.
Installation Process
~ git clone https//:github.com/charlytochi/E-School-Web-App.git
~ cd E-School-Web-App
~ composer install
~ php artisan migrate
~ php artisan serve 🥝`
Requirements
All the below mentioned Requirements are needed for successful Installation of the app.
| Tools | Version | Description |
|---|---|---|
| Composer | >=1.10 | Laravel packages installer |
| Xampp/Wampp | 7.0 and above | Local server in development mode |
| Postman | 7.26.0 | Test Api endpoint |
Project Folder Structure
~ app
~ bootstrap
~ config
~ database
~ public
~ resources
~ routes
~ storage
~ tests
~ vendor
~ .env
~ .gitattributes
~ .gitignore
~ composer.json
~ composer.lock
~ composer.phar
~ composer.phar
~ packages.json
~ packages-lock.json
~ README.md
~ server.php
The App folder contains All Http folder
API
The API its a built in features for synchronizing communication between Our school web app and mobile app, the API lives in the app/Http/Controllers/API folder
Features
New School Registration
Creation of new school can only be done on Web platform by the Super Administrator of Efull technology
Create Users {Parents, Teachers and Students}
All other users creation will be done by the admin of the school in web App. It will be further discuss in the Web section of this documentation
Users Login
Login method require 2 params
Method Type
POST
Api Name
https://sandbox-eschool.efulltech.com.ng/login{
params
email, password
response
access_token, token_type, user_data, school_names, accounts, message
}
Users Login Account
Login Account method require 2 params
Method Type
POST
Api Name
https://sandbox-eschool.efulltech.com.ng/loginAccount/id{
params
no param
response
students, children, messages, school_data
}
School MPOS Login
School Login method require 2 params
Method Type
POST
Api Name
https://sandbox-eschool.efulltech.com.ng/schoolLogin{
params
email, password
response
access_token, token_type, user, students, message
}
Students Log
protected method for logging students attendance and notifying parents of the children arrivals and departure from school
Method Type
POST
Api name
https://sandbox-eschool.efulltech.com.ng/saveStudentLog{
params
json_encoded: card code, timestamp
response
payload, response, error
}
Save Student Logs
Saves all students message log
Method Type
POST
Api name
https://sandbox-eschool.efulltech.com.ng/sentMessageLog{
params
json encoded data: message_id, message_content, message_isdn, student_card_code, card_id, message_sent
response
json_encoded responses
}
Get All School
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/getAllSchoolName{
params
no params
response
school_names
}
Update Profile
Update profile works for all users except admin and super admin
Method Type
POST
Api name
https://sandbox-eschool.efulltech.com.ng/updateProfile{
params
last_name, first_name, title, email, address, phone_number
response
message, user_data
}
Update Profile picture
Update profile picture works for all users except admin and super admin
Method Type
POST
Api name
https://sandbox-eschool.efulltech.com.ng/updateProfileImage{
params
profile_image
response
message, updated_data
}
Fetch All Account Type
Fetch all available account type
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/getAccountType{
params
no params
response
acct_type
}
Fetch All Parents
Fetch all parents related to a School
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/allParents{
params
school_id
response
parents
}
Fetch All Teachers
Fetch all Teachers related to a School
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/allTeachers{
params
school_id
response
teachers
}
Fetch Student Teachers
Fetch all Teachers related to a School and a class
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/studentTeacher{
params
school_id, class_assigned
response
teachers
}
Send Notification
Send Notification betwween parents and teachers
Method Type
POST
Api name
https://sandbox-eschool.efulltech.com.ng/sendNotif{
params
title, content, type, sender_id, reciever_id, school_id, reciever_acct_type, sender_acct_type,
response
message
}
Recieve Notification
Recieve Notification from parents/teacher
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/sendNotif{
params
reciever_acct_type, reciever_id, school_id
response
message, notifications
}
Read Notification
Read Notification
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/readNotif{
params
notif_id
response
message, notifications
}
Sent Notification
Sent Notification
Method Type
GET
Api name
https://sandbox-eschool.efulltech.com.ng/sentNotif{
params
sender_acct_type, sender_id, school_id
response
message, notifications
}