Skip to content

Quickly find all available in-person/remote tutors by subject, distance, price, rating, and more in a dating app like format that also allows messaging.

Notifications You must be signed in to change notification settings

sherrilla71940/TutorFinderTW

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

In both the client and server you will need to set up your environmental variables (port and host). The server uses these variables to start the server, and the client uses the variables to make http requests to the correct url. Each env file is located at the root of the folder (client and server).

Starting the backend API:

Move into the server folder in your terminal and type npm run serve. This will compile all your server TypeScript files and start your server on the host and port you specified in your server env file.

Starting the frontend server:


Getting started

Make sure you have Node.js installed or install it. Install the dependencies by running npm install command in the server and client directories.

To start a local development server:

  1. create a .env file in server/src directory and populate it with PORT and SECRET variables:
PORT=8080
SECRET="YOUR SECRET KEY"
  1. run nodemon index.ts command from server/src directory

To start the frontend server run npm start command from the top of the client directory.

By default, the frontend connects to http://localhost:8080. If you wish to use a different port, edit the env.ts file in client/src directory.

In the mocks directory you will find a json file with four user profiles: one student and three tutors. You can start the app and load this file into your MongoDB and copy the uploads directory into server/src directory to display images for these profiles. Password1 is the password for all the mock profiles.

Tech stack

TypeScript on the frontend and the backend

Front end

React, Bulma (CSS framework)

Backend

Node.js and Express for creating the server, jsonwebtoken and bcrypt for authentication, multer for form data handling, MongoDB with Mongoose (ODM library).

Contributors

This project was intially started by Aaron Sherill and has been greatly improved through the contributions of Anton Novak and Danny Gold. Their valuable contributions and enhancements have been instrumental in elevating the project's development and enhancing its overall quality.

About

Quickly find all available in-person/remote tutors by subject, distance, price, rating, and more in a dating app like format that also allows messaging.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •