Suman-00X / Du-Buddy

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Teacher Buddy

Teacher Buddy is a web application designed to facilitate communication and scheduling between students and teachers at a university. It allows students to request sessions with teachers and provides a dashboard for both students and teachers to manage session requests.

Features

  • User Authentication: Users can register, login, and logout securely.
  • Profile Management: Users can view and edit their profiles.
  • Session Requests: Students can request sessions with available teachers.
  • Dashboard: Separate dashboards for students and teachers to manage session requests.
  • Responsive Design: The application is designed to work well on both desktop and mobile devices.

Technologies Used

  • Frontend: React.js, React Router
  • Backend: Node.js, Express.js, MongoDB
  • Authentication: JSON Web Tokens (JWT)
  • HTTP Requests: Axios
  • Styling: CSS

Project Setup

  1. Clone the repository: git clone https://github.com/Suman-00X/Du-Buddy.git
  2. Navigate to the project directory: cd du-buddy
  3. Install backend dependencies: cd backend npm install
  4. Setup .env in backend directory: MONGO_URI(MongoDB Atlas connection string), JWT_SECRET, USER_EMAIL(the email which you want to use to send emails on class booking/acceptance/rejection), USER_PASS(password of email, in case yiu are using personal gmail account then use app password)
  5. Start Backend Server : nodemon index.js 5.Install frontend dependencies : cd .. cd frontend npm install
  6. Start the development server: npm start
  7. Open your browser and visit http://localhost:3000 to view the application.

App URL

The DU Buddy web application is deployed and accessible at https://teacher-dubuddy.netlify.app/.

API URL

The backend API for DU Buddy is hosted at https://du-backend.onrender.com/.

Contributing

Contributions are welcome! If you find any bugs or want to suggest new features, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.


About


Languages

Language:JavaScript 82.0%Language:CSS 14.3%Language:HTML 3.7%