Skip to content

KoTubA/hr-study-buddy

Repository files navigation

Hello Roman Study Buddy – React course

Project prupose

Studdy Buddy - an app for college teachers to manage students. It was created while learning React on the hello roman channel for supporters. The repository has been divided into separate branches for each of the 26 available lessons. The main branch contains additional functionality not covered in the course (course assumptions), the last branch related to the course is summary-refactor.

desktop-design-dashboard

How to run?

1. Clone this repository:

git clone https://github.com/KoTubA/hr-study-buddy.git

or:

git clone git@github.com:KoTubA/hr-study-buddy.git

2. Install npm packages:

npm install

How to log in?

All mocked data is located in src/mocks/db directory.

To sign in with test user use teacher@studybuddy.com/Test123 credentials.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 and view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run test:e2e

Launches Cypress tests.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm storybook

Launches Storybook on http://localhost:6006 to view it in the browser.
The page will reload if you make edits.

Live demo

Link to demo: https://hr-study-buddy.netlify.app