LEL School, an academic management project.
LEL School is a web application based on our very own REST API and created with just one intend: to simplify managements within an academic environment. Wether you are a principal, a teacher or a student... the management of appointments, messages and courses is no longer a concern!
LEL School has three different views depending on your role in the academic center:
If you are the school's principal you can:
- Register new teachers and students
- Create, update and delete events
- Create, update and delete the subjects of each course
- Assign a teacher to each subject
If you are a teacher you can:
- Update the subjects info
- Sign up for events
If you are a student you can:
- Sign up for events
Everyone can:
- Send and receive messages from the app (which are notified via email)
- Modify your own profile (upload a cool picture!)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them:
-
Create a
.env
file on the root directory to populate the database (DB
) and port (PORT
) -
Get yourself some free keys to Cloudinary and GoogleMaps and add them to the
.env
file -
Run
npm i
command on the root directory!
- Run
npm run dev
command on the server directory - Run
npm start
command on the client directory
See our API REST documentation through our beloved Postman Collection 💌
Click here to see the running app!!
This project was developed under the lovely guidance of @Dayanro at Ironhack_Madrid 💙