Code Monkey home page Code Monkey logo

coolyashas / tutorhub Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 404 KB

A tutoring website where interested tutors can conduct one on one sessions with students in need to teach specific subjects. This platform bridges the gap between prospective tutors and students. Our target audience includes college students who can tutor students and gain AICTE points.

License: MIT License

Python 12.36% CSS 39.17% HTML 2.21% Procfile 0.04% JavaScript 46.22%
django-project education sqlite-database

tutorhub's Introduction

TutorHub

Description

TutorHub is a tutoring website that connects students in need with tutors for one-on-one sessions in specific subjects. This platform aims to bridge the gap between tutors and students, catering to college students looking to tutor and earn AICTE points.

Installation & Setup

To run the project locally, follow these steps:

  1. Clone the repository to your local machine.
  2. Set up your Django environment.
  3. Run the Django development server with python manage.py runserver.

Features

  • User authentication and registration.
  • Session scheduling for tutors.
  • Session booking for students.
  • Review and rating system for completed sessions.
  • Subject selection and profile customization for users.

Usage

  1. Visit the homepage to view available sessions or scheduled sessions based on your user type.
  2. Students can book sessions, and tutors can view and manage their scheduled sessions.
  3. After a session, both students and tutors can provide reviews and ratings.
  4. Users can customize their subjects and profile information.

Main Files

  • models.py: Defines the database models for subjects, user profiles, sessions, and reviews.
  • views.py: Contains the logic for handling user requests, session bookings, and reviews.
  • forms.py: Includes forms for user registration, login, session creation, and reviews.

Database

The project uses Django's default database (SQLite) with tables for subjects, user profiles, sessions, reviews, and more.

Contribution Guidelines

If you wish to contribute to TutorHub, follow these guidelines:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your feature or bug fix.
  3. Implement your changes and ensure they are properly tested.
  4. Commit and push your changes to your forked repository.
  5. Submit a pull request to the main repository, clearly explaining your contributions.

Your contributions are valuable!

Contact

For questions, feedback, or suggestions, please reach out:

Release Notes

Version 1.0

  • Initial release

Next Release:

  1. More test cases to ensure comprehensive coverage.
  2. Students cannot book additional sessions unless they have reviewed a finished class.
  3. Tutors cannot create more sessions unless they have confirmed the status of previously 'booked' classes ('finished' or 'missed') by the student.
  4. Enforce reviews for both students and tutors.

tutorhub's People

Contributors

coolyashas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.