eduSync is a class management system built using Next.js, Node.js, and PostgreSQL.
eduSync is a comprehensive class management system designed to streamline the process of managing classes, students, assignments, schedules and other such academic data related to a student. It includes both frontend and backend components, developed using Next.js, Node.js and postgreSQL for database.
The project has not been hosted yet so you might wanna have to clone the repositories and run them locally inorder to see the working. Before you begin, ensure you have met the following requirements:
- Node.js installed on your machine
- PostgreSQL database set up
- Git installed on your machine
Follow these steps to set up and run the project locally.
git clone https://github.com/n1ved/edusync-frontend.gitgit clone https://github.com/nikhilt77/eduSync_Backend.gitNavigate to the frontend directory:
cd eduSync-frontendInstall the dependencies:
npm installStart the frontend server:
npm run devNavigate to the backend directory:
cd ../eduSync_BackendInstall the dependencies:
npm installSet up the PostgreSQL database and configure the environment variables.
Start the backend server:
npm startTo use eduSync, follow these steps:
- Open your browser and navigate to the frontend server URL (usually http://localhost:3000).
- Log in or sign up to access the class management features.
If you want to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -m 'Add some feature' - Push to the branch:
git push origin feature/your-feature-name
- Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
For any questions or feedback, please contact:
Nikhil - GitHub Profile Nived - GitHub Profile Rahul - GitHub Profile Karthik - GitHub Profile
