OD Claimer Application

A web application designed for managing Online Duty (OD) requests for students and teachers. The application allows students to apply for OD, while teachers can approve or reject these requests. Event coordinators can also update relevant events.

Table of Contents

• Features
• Technologies Used
• Installation
• Usage
• API Endpoints
• Contributing
• License

Features

• User Authentication: Supports student, teacher, and event coordinator login.
• Dashboard: Separate dashboards for students and teachers.
• OD Application: Students can apply for OD.
• Event Management: Teachers and event coordinators can manage events.
• Responsive Design: Works on various screen sizes.

Technologies Used

• Frontend:

  • React.js
  • React Router
  • Axios
  • Tailwind CSS
  • Framer Motion
  • React Calendar

• Backend:

  • Node.js
  • Express
  • MongoDB

Installation

To get started with the project, follow these steps:

1. Clone the repository:

   https://github.com/RAGAV-24/OD-CLAIMER.git

Navigate to the project directory:

cd OD Install the required dependencies:

npm install Start the development server:

npm start Usage Sign In: Open the application in your browser and sign in as a student or teacher. Dashboard: Navigate to your respective dashboard to view and manage OD requests or events. Apply for OD: Students can apply for OD through the dashboard. Manage Events: Teachers can view and manage events and approve or reject OD requests. API Endpoints POST /signin: Authenticate users. GET /api/students: Fetch student data. POST /api/od: Submit an OD application. (Include any additional API endpoints your application supports)

Contributing Contributions are welcome! If you have suggestions or improvements, please fork the repository and create a pull request.

Fork the repository. Create a new branch (git checkout -b feature/YourFeature). Commit your changes (git commit -m 'Add some feature'). Push to the branch (git push origin feature/YourFeature). Open a pull request. License This project is licensed under the MIT License - see the LICENSE file for details.

Instructions for Customization

• Project Name: Change the title and description if needed.
• Features: List specific features your application has.
• Technologies Used: Update this section if there are additional libraries or frameworks used.
• Installation and Usage: Make sure these instructions match your project setup.
• API Endpoints: Include all the endpoints that your backend supports.
• Contributing: Modify the contribution guidelines according to your preferences.
• License: Update if you're using a different license.

Saving the README

Save the file as README.md in the root directory of your project. This file will automatically render on GitHub, making it easy for others to understand your project.

Feel free to ask if you need more help or specific adjustments!