lakshay451/ElectiveHub

ElectiveHub is an Education Management System designed to simplify and enhance the management of student information and elective subject selection in educational institutions. It offers a suite of applications for students, teachers, and administrators, providing a user-friendly platform.

ElectiveHub

Description:

ElectiveHub is an Education Management System designed to simplify and enhance the management of student information and elective subject selection in educational institutions. It offers a suite of applications for students, teachers, and administrators, providing a user-friendly platform to manage academic processes efficiently.

Table of Contents

1. Features
2. Installation
3. Contributing
4. License

Features

• Student Information Management: Add, update, and delete student details, including Student Name, Student ID Number, Email, and Phone Number.
• Elective Subject Management: Add, update, and delete elective subjects with details like Elective Subject Name, Description, and Code.
• Syllabus and Timeline: Access detailed syllabus information for elective subjects and follow a structured learning timeline.
• Elective Subject Selection: Students can choose elective subjects, while teachers can assign them to students.
• Admin Dashboard: Visualize data with charts and analytics to make informed decisions about curriculum and student engagement.

Creating .env file for client

A file named .env is required in the client directory of ELECTIVEHUB for storing environment variables used at runtime. It is not a part of the repo and you will have to create it.

Add the endpoint for accessing electivehub-api service to the variable named "VITE_API_URL" in the .env file.

VITE_API_URL="http://your-server.com"

If you are a developer working on your local system, then the URL would be:

VITE_API_URL="http://localhost:4000"

Creating .env file in server

A file named .env is required in the server directory of ELECTIVEHUB for storing environment variables used at runtime. It is not a part of the repo and you will have to create it.

Create the following variables in the .env file and assign there values.

MONGO_URL PORT TOKEN_KEY

Installation

To get started with ElectiveHub, follow these installation steps:

1. Clone the repository to your local machine:

   git clone https://github.com/TechNodes2-0/ElectiveHub.git
   

2. Set up the backend by navigating to the server directory:

   cd server
   

3. Install the necessary dependencies for the backend:

   npm install
   

4. Start the backend server:

   npm start
   

5. For the frontend, navigate to the client directory:

   cd client
   

6. Install the necessary dependencies for the frontend:

   npm install
   

7. Start the frontend:

   npm run dev
   

8. Access the application through your web browser.

These steps will ensure both the frontend and backend of ElectiveHub are properly set up and running.

Contributing

We welcome contributions to improve ElectiveHub. To contribute:

1. Fork the repository on GitHub.

2. Clone the forked repository to your local machine.

3. Make your changes and improvements.

4. Commit your changes with clear and concise commit messages.

5. Push your changes to your forked repository.

6. Submit a pull request to the main repository, describing your changes and why they should be merged.

License

This project is licensed under the MIT License.