bitadj / react-tailwind

Unite Us Client Portal

Client portal self-service application.

Getting Started

Prerequisites

• node v18.0.0
• npm v8.6.0

Installation

Clone the Repo and install dependencies

  git clone https://github.com/unite-us/client-portal.git
  cd client-portal
  npm install

Copy environment variables

  cp .env.sample .env

Running the Server

To run the application locally

  npm start

The default port is set in .env to 8787, but you may use any port you wish
Open http://localhost:8787 to view it in the browser.

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

Testing

Launch the test runner in the interactive watch mode

  npm test

Every time you save a file, the tests will re-run for files changed since the last commit.

Static Testing

Typescript for applying types. | TypeScript Handbook
ESLint for linting. | ESLint - Pluggable JavaScript linter
Prettier for formatting. | Opinionated Code Formatter

Unit & Integration Testing

React Testing Library for unit and integration testing. | React Testing Library
Jest for the test runner. | Jest

End-to-End Testing

TBD

Deployment

Builds the app for production to the build folder.

  npm run build

...TBD deployment steps...