🔥 React w/MUI and @timmons-group shared components

📚 Overview

This is a starter repo for a React Application. What is in this repo?

1. React Typescript application with Vite.
2. MUI - React components built on material design
3. Timmons Group shared components
   1. Shared React Components - Includes several components built using MUI components
   2. Config Form - Configurable forms using react-hook-form, yup, and based on MUI form components
   3. Shared React Auth - Hooks and methods to facilitate auth with AWS cognito
   4. Shared Auth Config - Methods to help build a config object for use with shared react auth.
   5. AppBar - Standardized Timmons application header bar. Assumes authorization done via useAuth library
4. Material React Table - Powerful data grid built using material components on top of TanStack Table v2
5. Zustand - global state management. Your project may not need this.
6. react-query - A data fetching library
7. Axios - cause fetch usually ain't it
8. notistack - Library to help use MUI's stackbar across the application

💻 Local Dev Setup

IDE

Recommend VS Code. The following VS Code extensions are recommended (see full recommendations in .vscode/extensions.json):

• EditorConfig
• ESLint
• SonarLint

Tools

• Node JS LTS

🏃‍♂️ How to Run

Install Dependencies

1. npm i

Run Dev Server

Recommended script for local dev. start:dev will start the frontend on port 4000 and the backend on port 4001.

npm run start:dev

We use cross env to help with setting env variables.

Additional NPM Scripts/VS Code Tasks

See that package.json for additional useful scripts.

TODO: expand this section as needed.

🙋‍♀️ Who do I Talk to?

• Chaz Mateer
• Bryant Overgard
• Nathan Grant