RFP: Peer mock technical interview platform

Installation

Clone the repository

git clone git@github.com:hatchways/team-bulldozer-2.git -b dev

Switch to the repo folder

cd team-bulldozer-2

Start the backend

Donwload and start a mongo docker container

docker run --name hatchways-mongo -p 27017:27017 -d mongo:4.4-bionic

Switch to the backend folder

cd server

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env    

Install all the dependencies using node

npm i

Start the local development server

npm run dev

You can now access the server at http://localhost:3001

Start the frontend

Switch to the frontend folder

cd client

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env    

Install all the dependencies using node

npm i

Start the app locally on http://localhost:3000

npm start

Frontend react app structure

client
├───public              # Static files
├───src
├───├───assets          # Visual assets (images, icons, etc.)
├───├───components      # Reusable components
├───├───layouts         # Layouts used by the routes to render the different interfaces
├───├───pages           # Page components that get rendered into the layouts
├───├───themes          # Material UI theme definition
├───├───utils           # Utils classes
├───├───├───api         #   - Static classes that wrap backend API calls
├───├───├───context     #   - classes that handle app context
├───├───routes          # All classes that concern the routes
└───    App.jsx         # App init + routes
└───    index.jsx       # Main entry point / app mount
```