README.md

boilerplate-web-app

This project is a minimal boilerplate meant as a starting point for developing new web applications. It was originally created through create-react-app but was later migrated to vite for faster development.

It is a work in progress and will be continuously updated with new features and improvements.

Features

• User registration and login, using AWS Amplify
• Using GraphQL queries to connect to a DynamoDB database holding user data
• MUI for user interface
• Typescript because static typing is awesome
• ESLint and Prettier configured
• Test setup with Vitest

---

Pre-requisites

• AWS CLI installed and configured

  • https://docs.aws.amazon.com/cli/latest/userguide/getting-started-prereqs.html

• AWS Amplify CLI installed

  • npm install -g @aws-amplify/cli
  • yarn global add @aws-amplify/cli

• Amplify configured

  • Run command amplify configure and follow the instructions to create an IAM user with programmatic access and admin privileges

---

Getting Started

You will need to initiate a new Amplify project through the AWS CLI for the authentication to work. Then you'll need to add the authentication resource to the project, and finally push your changes. Run the following commands in your terminal and follow the instructions:

• amplify init
• amplify add auth - choose default configuration and user as the sign-in method
• amplify push - to push your changes to the cloud, enabling logging in and registering users

TODO: Write more specific instructions for setting up amplify and graphQL

---

Further additions

Here are some useful additions that are not currently included. If you open this file in your IDE, you can run these commands by clicking on them.

• yarn add lodash - Lodash
• yarn add @types/lodash -D
• yarn add react-router-dom localforage match-sorter sort-by - React Router
• yarn add react-redux @reduxjs/toolkit - Redux
• yarn add react-hook-form - React Hook Form
• yarn add react-use - React Use

Miscellaneous:

• yarn add victory @types/victory - library for creating charts
• yarn add video.js - video player library
• yarn add @types/video.js -D
• npx storybook init - Storybook

---

Available Scripts

Standard vite scripts

• You can run yarn start to start the development server, yarn test to run the tests, and yarn build to build the app for production.

Custom scripts

• yarn lint will run ESLint and Prettier on the codebase and give you an error report.
• yarn lint:fix will run ESLint and Prettier on the codebase and fix any errors that can be fixed automatically.
• yarn format will run Prettier on the codebase and fix any errors that can be fixed automatically.