https://github.com/bitbravo/react-auth
https://github.com/bitbravo/react-auth
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitbravo/react-auth
- Owner: BitBravo
- Created: 2024-04-25T02:06:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T07:55:52.000Z (about 2 years ago)
- Last Synced: 2025-01-02T04:27:52.859Z (over 1 year ago)
- Language: TypeScript
- Size: 270 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```bash
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](https://github.com/nvm-sh/nvm).
- Once NVM is installed, install the Node.js version used in this project:
```bash
nvm install node
```
- Switch to the installed version:
```bash
nvm use node
```
- Verify the Node.js version
```bash
node -v
```
## Installation
To get the app running locally:
Clone the repository and install dependencies:
```bash
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:
```bash
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:
```bash
npm run test
# Or with Yarn
yarn test
```