Breaktime Frontend

This repo contains all the code for the backend of Project Breaktime, a project developing a time-tracking dashboard. This project utilizes a ReactJS (Frontend) and NodeJS (Backend).

Installation

To setup this project ensure that you currently have react installed.

Install React

Once installed, all that is needed to install all required dependencies is the following line:

npm install

You should now be ready to start running things!

Note: If you are missing a file in src/aws-exports.tsx reach out to the tech-lead for this file, or copy aws-exports.js into this name.

Running the Project

To run the frontend several steps are required:

Run the following command: npm start After this you should see a browser open to localhost:3000.
Start the backend - for instructions see breaktime-backend under the c4c repo. Once this is running you should be able to start interacting with the website.
From step 1 you should be greeted with a log-in window asking you to sign in with a user name and password. These can either be provided by asking anyone on the breaktime team, or by navigating to the Cognito pool for breaktime and creating this yourself: Ask a developer on project breaktime for instructions on this

Once logged in, you should be ready to go and interact with the website.

Code Overview

The frontend is using a typescript / react and currently utilizes AWS Amplify for handling authentication.

Reading Material

Codebase Design

Important directories and files are described below. While not all files are described, these provide a general overview of the structure.


breaktime-frontend/
├─ public/ - Static assets that should exist on the frontend 
├─ src/ - Directory housing almost all code 
│  ├─ components/ - React Component Modules 
│  |  ├─ Auth/ - Authenticated API interface and components 
|  |  |  ├─ apiClient.tsx - The central interface making authenticated calls to the backend. 
│  |  ├─ HomePage/ - Components for the landing & home page 
│  |  ├─ NavBar/ - Components for the navigation bar 
│  |  ├─ SignOut/ - Components for the signout page 
│  |  ├─ TimeCardPage/ - Components for the timesheet page 
|  |  |  ├─ CellTypes/ - Contains all types of cells rendered on the timesheet 
│  ├─ schemas/ - Typescript schemas for complex data types 
│  ├─ aws-exports.js - AWS configuration file for Cognito 
│  ├─ constants.tsx - Frontend global constants file 
│  ├─ index.css - styling for root of the project 
│  ├─ index.tsx - root JS file 
├─ .gitignore - files ignored by git 
├─ package.json - react project configuration files 
├─ README.md