/react-auth

Primary LanguageTypeScript

CGX TEST

Welcome to CGX test! This project is built using a modern front-end stack that includes React, TypeScript, Tailwind CSS, Vite, Jest, and Formik to deliver a seamless and scalable user experience.

Features

  • React: Utilizes functional components and hooks for efficient state management and lifecycle events.
  • TypeScript: Enhances code quality and predictability through strong typing.
  • Tailwind CSS: Employs utility-first CSS framework for rapid UI development.
  • Vite: Leverages Vite as a build tool for blazing fast development and optimized builds.
  • Jest: Ensures reliability with Jest for comprehensive unit and integration tests.
  • Formik: Manages forms seamlessly with Formik for robust form validation and handling.

Prerequisites

Node.js (v18.x) npm (v8.x) or Yarn (v1.22.x)

Ensure you have Node.js and npm installed by running:

node --version
npm --version
yarn --version

Setup with NVM

To manage different Node.js versions, we recommend using NVM. Here's how to set it up:

  • Install NVM by following the instructions on the NVM GitHub page.
  • Once NVM is installed, install the Node.js version used in this project:
nvm install node
  • Switch to the installed version:
nvm use node
  • Verify the Node.js version
node -v

Installation

To get the app running locally: Clone the repository and install dependencies:

git clone https://github.com/BitBravo/react-auth.git
cd react-auth
npm install

# Or if you use Yarn

yarn install

Running the Development Server

To start the development server with hot module replacement (HMR), run:

npm run dev

# Or with Yarn

yarn dev

Test Login Credentials

For testing purposes, use the following credentials to log in:

Email: aleksei@example.com
Password: lkJlkn8hj

Running Tests

To run tests, use:

npm run test

# Or with Yarn

yarn test