edWorld is a web app is designed to assist educational institutions in managing their students and teachers. It includes a range of features such as admission management, batch creation with assigned teachers and subjects, student attendance and performance tracking, and fee payment management. On top of node js express and mongodb the platform has utilised various technologies including Bootstrap, Razorpay, Nodemailer, and Cloudinary to improve its functionality and user experience. It has been hosted on AWS with EC2 and Route 53 to ensure seamless access and scalability.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Requirements you need to run the software and how to get them.
- Git
- NodeJs
- Mongodb
- Oauth tokens for your email to setup nodemailer
- Razorpay account
- Cloudinary account
A step by step series of examples that tell you how to get a development env running.
Clone this repository to your local system.
git clone https://github.com/shamilkotta/edWorld.git
Then go to this project directory by running command cd edWorld
Firstly install the required packages
npm install
Then you've to setup env file.
Create a .env file and paste the keys inthe sample.env and add your values.
Then start the dev server by executing
npm run dev
Now you can navigate to browser in url http://localhost:5000 (by default) to see the output.
Check if any files need to be formatted, if the check fails that means some files needed to be formatted or have to do some fixes.
eslint
npm run lint
prettier
npm run pretty
To format all required code files
npm run style
Read contributing instructions and guidlines from here.
This project follows the all-contributors specification. Contributions of any kind are welcome!