mySchool

A one stop School Management Portal

Managing schools require a lot of resources and man-power. mySchool is created with the aim to minimise the wastage of resources and help the schools to properly manage the schools.

The portal's for everyone.

Not only for the admins, but this is a one stop portal for the entire school including teachers, students and parents. Lot of functionalities are added keeping the novelty factor for the project in mind.

TechStacks Used:

The website has been developed using MERN Stack. MERN stands for MongoDB, Express, React, Node, after the four key technologies that make up the stack.

• MongoDB - document database
• Express(.js) - Node.js web framework
• React(.js) - a client-side JavaScript framework
• Node(.js) - the premier JavaScript web server

Installation Guidelines:

In order to run the website please follow the mentioned guidelines:

1. Clone the repository onto your personal computer.
2. If using windows, we recommend installing Hyper (an electron-based terminal). If using Mac/linux, the native terminal would be fine. Please install hyper using this link :- Click Here
3. Please install node on your system using this link: https://nodejs.org/en/
4. Please install nodemon on your system using this link: https://www.npmjs.com/package/nodemon
5. Please install npm in the frontend folder using the command "npm install"
6. Please install npm in the backend folder using the command "npm install"
7. Please setup your own mongoDB on your system as the password for the database cannot be provided with the repository.
8. Please create a .env file and add your corresponding MONGO_URL and SESSION_SECRET in the file
9. Congrats! Now you can run the website on your pc.

Instructions for starting the website:

1. Please open the terminal and move into the mySchool directory.
2. Move into the backend directory and start the backend server on port 5000 by running the command: "nodemon server.js"
3. Open a new terminal tab and move into the frontend directory and start the React app by running the command: "npm start"
4. Now you can test and explore the website in your favourite browser.

Screenshots of the website:

Please note that the site is completely responsive. It works flawless in all sorts of devices including android mobiles, iphones, iPads, tablelts, laptops and large computers. Attached is the screenshot of the website in iPhone X: