Skip to content

RCDD-202110-TUR-BEW/backend-capstone-turkey-students-teach

Repository files navigation

Students Teach 👩‍🎓👨🏿‍🎓

Created by students for students

Students Teach is a platform that connects students with other students and creates an environment where students help each other out!

⚡️ Quickstart

To get a local copy up and running follow steps below:

Prerequisites

Below tools are required to run the application:

Installation

Open your terminal and paste below commands:

git clone git@github.com:RCDD-202110-TUR-BEW/backend-capstone-turkey-students-teach.git
cd backend-capstone-turkey-students-teach

It clones the repo and goes to the cloned directory. Change the .envsample file name as .env, and fill it with your information.

yarn

It installs the dependencies

yarn start

It runs the app in the development mode. Default port is http://localhost:3000 You will also see any lint errors in the console.

yarn test

Launches the test runner

🎯 Features

  • Students can register / login via JWT or Google Auth
  • Students can become tutors
  • Students can ask and/or answer the questions
  • Users can filter and search questions and tutors
  • Students can communicate inside channels
  • Crud operations for questions
  • Crud operations for tutors
  • Crud operations for messaging channels
  • Middleware for only auth and only tutor
  • Unit tests via using jest framework

Check out our application

Student Teach

Technologies

  • React-shield
  • Html-shield
  • Css-shield
  • Figma-shield
  • Github-shield
  • Git-shield
  • Prettier-shield
  • Eslint-shield
  • mongodb-shield
  • nodejs-shield
  • express-shield
  • express-validator-shield
  • swagger-shield
  • Jest-shield
  • Cron-shield
  • AWS-shield

Images From Our Project

System Architecture Diagram

System Architecture

Database Schema Design

Database Schema

Home Page

Home Page

Question Page

Question Page

Our Team

Meet our team members through their GitHub profiles

Ammar
@Ammar
ali-riza
@alfawal
aziza
@emirsagit
nur
@ehabhalil
kutay
@inasalarabi
moulham
@Muhammeday99

About

Connect students with other students and to create an environment where students help each other out!

Topics

Resources

Stars

Watchers

Forks