aquia-inc / template-vite-react

Vite-powered React template that uses TypeScript and SWC for building highly performant applications. Comes with modern tooling and scripts for building, testing, and developing applications efficiently. Includes authentication support with AWS Cognito and protected routes.

template-vite-react

Overview

This project contains the application's UI built with React, Vite, TypeScript, and SWC. It requires Node.js v20, nvm (or n), and Yarn v4.

System Requirements

• Node 20
• Yarn
• GitLeaks

Getting Started

1. Clone the repository and cd into the root directory:

git clone [e-mail]:aquia/template-vite-react`

cd template-vite-react

2. Setup Node.js and Yarn

# using nvm
nvm install --latest-npm
nvm use

# using n
n install auto
n use auto

# enable corepack
corepack enable yarn

3. Install dependencies:

yarn

3. Install pre-commit hooks:

yarn prepare

Building

To build the application, run the following from the root directory:

yarn build

Testing

To run all tests, run the following from the root directory:

yarn test

To lint all files, run the following from the root directory:

yarn lint

Developing

First, run the post-install script to create the local development environment file from the example environment file.

sh ./scripts/post-install.sh

To start the local development server, run the following from the root directory:

yarn dev