Giter VIP home page Giter VIP logo

ondemandtutor-backend's Introduction

MyTutor - Student Booking Tutor On Demand

MyTutor

MyTutor is a web application that provides services for students and tutors.


Table of Contents

  1. Introduction
  2. Tech Stacks
  3. Installation
  4. API Documentation
  5. Use Case Diagram
  6. Database Design
  7. Screen Flow
  8. Team Members
  9. Appendix A

0. Introduction

Welcome to MyTutor, your premier online tutoring scheduling application. At MyTutor, we connect students with expert tutors from around the world, offering personalized and flexible learning experiences. Whether you're seeking help with school subjects, preparing for exams, or looking to learn a new skill, our platform makes it easy to find and schedule sessions with qualified tutors. Our user-friendly interface, secure payment system, and comprehensive tutor profiles ensure that you receive the best possible tutoring experience. Join MyTutor today and take the first step towards achieving your educational goals!

  • Students can create online appointments with tutors, real-time chat 1v1, feedbacks, make payments using VNPay, MoMo, PayPal.
  • Tutors can easily create profiles, showcasing their qualifications and availability.
  • Admin can manage users account, view dashboards, reports.
  • Moderators review and verify tutors' information, students' questions.

1. Tech Stacks

Client
  • Typescript
  • Reactjs
  • ANT Design
  • Styled Components
  • Axios
Server
  • Spring Boot
  • Spring Mail
  • Spring JPA
  • Hibernate
  • Spring Security
  • JWT
  • OAuth2.0
  • Swagger OpenAPI
  • WebSocket
Database
  • MySQL
Deployment
Others
  • VNPay
  • MoMo
  • PayPal
  • Firebase

2. Installation

To get a local copy of the project up and running, follow these steps.

Prerequisites

  • Java 17
  • Maven
  • MySQL

Clone the repository:

git clone https://github.com/vandatnguyen919/OnDemandTutor-Backend.git

cd OnDemandTutor-Backend

Configure the database

Add application.yml to resources

Build the project

mvn clean install

Run the application

mvn spring-boot:run

The application will start on http://localhost:8080.

3. API Documentation

API documentation is provided using OpenAPI. Once the application is running, you can access the API documentation at:

http://localhost:8080/swagger-ui/index.html

Or access our deployed API documentation:

https://my-tutor-render.onrender.com/swagger-ui/index.html

4. Use Case Diagram

5. Database Design

6. Screen Flow

7. Team members

Appendix A

Test Accounts

Use the following test account to explore the MyTutor application:

Student

email: [email protected]
password: Password123.

Tutor

email: [email protected]
password: Password123.

Moderator

email: [email protected]   
password: Password123.

Admin

email: [email protected]
password: Password123.

ondemandtutor-backend's People

Contributors

vohoa2004 avatar vandatnguyen919 avatar

Stargazers

 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.