Skip to content

Latest commit

 

History

History
59 lines (33 loc) · 1.55 KB

README.md

File metadata and controls

59 lines (33 loc) · 1.55 KB

Homework Homie

Project Objectives

  • Create a user-friendly homework platform. That enables children to organize their school task, homework, upcoming exams and more.

Technologies

The following technologies were used to develop Homework Homie:

Languages

  • HTML
  • CSS
  • JavaScript

Libraries & Frameworks

  • React (JavaScript library for building user interfaces)
  • Express (backend framework for Node.js)
  • MySQL (database technology)

Tools

  • Vite (frontend build tool)
  • Node.js (server-side JavaScript execution environment)
  • CORS (Cross-Origin Resource Sharing middleware for enabling cross-origin requests)

Setup

  • Clone this repo to your local machine.

  • Open a new terminal window and cd into the root of your PROJECT FOLDER.

  • To install the project dependencies, type and run: npm install.

  • In the same terminal window, cd client and run npm install to install dependencies related to React (the client).

Run Your Development Servers

  • Open a new terminal window and cd into the root of your PROJECT FOLDER.

  • Run npm start to start the Express server on port 5000.

  • Open a new terminal window and cd into the client folder.

  • Once in the client folder, run npm run dev to start client server in development mode with hot reloading in port 5173.

  • You can test your client app in http://localhost:5173

  • You can test the backend in Postman with the following: http://localhost:5000/homework

Login and New Student Auth for Backend

  • you will need to run 'npm install bcrypt jsonwebtoken'