Skip to content

thon1525/learnwithkru-monorepo

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

Project Learnwithkru

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contact

About The Project

In a digitally interconnected world, the demand for personalized education has never been higher. Students and learners of all ages are seeking tailored learning experiences that cater to their individual needs, preferences, and schedules. Meanwhile, educators are looking for flexible platforms that allow them to reach a broader audience and provide impactful, one-on-one instruction. Our project aims to bridge this gap by creating an innovative platform designed to connect students and teachers for personalized, one-on-one educational experiences, similar to the well-established Preply platform.

Our platform leverages cutting-edge technology to facilitate seamless interactions between students and educators. By providing a user-friendly interface, robust search functionalities, and secure communication tools, we empower learners to find the perfect teacher who can guide them through their educational journey. Teachers, in turn, gain access to a diverse pool of students, allowing them to expand their reach and impact.

Whether it's mastering a new language, excelling in academic subjects, or acquiring new skills, our platform is dedicated to making personalized education accessible and effective. Join us in revolutionizing the way education is delivered and received, creating meaningful connections that foster growth, learning, and success.

(back to top)

Built With

This section lists major frameworks and libraries used in the Learnwithkru project:

  • Node.js
  • TypeScript
  • Express
  • MongoDB

(back to top)

Getting Started

With Docker

Follow these steps to set up this project locally using Docker.

Prerequisites

Ensure you have the following software installed before proceeding:

Setup Steps

  1. Navigate to the volumes folder:

    cd volumes
  2. Build and run the Docker containers:

    docker-compose up --build

After completing these steps, your project will be successfully set up locally!

Without Docker

If you prefer to set up the project without Docker, follow these commands:

  1. Navigate to the specific service directory:

    cd service_name
  2. Install the necessary Node.js modules:

    npm install
  3. Start the development server:

    npm run start:dev

(back to top)

Usage

Our platform supports three types of users, each with distinct features and functionalities:

1. Normal User

  • Explore: Browse through the platform to understand the features and services offered.
  • Search: Use the search functionality to find courses, tutors, and resources without registering.

2. Student

  • Join Classes:
    • Search for Tutors: Use the search feature to find tutors based on your specific needs and preferences, such as subject, availability, and ratings.
    • View Tutor Profiles: Check detailed profiles of tutors, including their qualifications, teaching style, and reviews from other students.
    • Book a Lesson: Schedule and book lessons at times that suit you through a seamless booking process.
  • Attend Lessons:
    • Join Lessons: Participate in scheduled lessons via our secure video platform, enabling real-time interaction with your tutor.
    • Access Learning Materials: Receive customized learning materials from your tutor to aid your learning journey.
  • Track Progress: Monitor your learning progress and review past lessons to ensure continuous improvement.
  • Communicate: Use our secure messaging system to stay in touch with tutors for any additional support or questions.

3. Teacher

  • Create Profile:
    • Post Profile: List your qualifications, teaching experience, and the subjects you teach to attract students.
    • Upload Media: Add introductory videos and other media to give potential students a better understanding of your teaching style.
  • Manage Classes:
    • List Available Times: Specify your availability so students can book lessons at convenient times.
    • Conduct Lessons: Use our secure video platform to conduct one-on-one or group lessons.
  • Interact with Students:
    • Provide Learning Materials: Share customized materials to support your students' learning.
    • Receive Reviews: Collect feedback from students to improve your profile and attract more learners.
  • Track Earnings: Monitor your earnings and manage payments through our integrated system.

For more examples and detailed instructions, please refer to the Documentation

(back to top)

Contact

Smoeury Songvat - (https://www.facebook.com/vath.goodboi) - learnwithkru287@gmail.com

Project Link: https://github.com/your_username/repo_name

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 88.9%
  • EJS 10.9%
  • Other 0.2%