arturacm/finder-pet

React + TS application for finding and adopting a pet

finder-pet

React + TS application for finding and adopting a pet

Deployed at https://finder-pet.netlify.app/

Application

Technologies

Frontend application with:

• React

• TypeScript

• SASS

• React Hook From

• Zod

• Redux

• Jest

• React Testing Library

• EsLint

• Lint Staged

• Husky

• Supabase

• Commitlint

• Vite

• React-router-dom V6

• yarn

• nvm

Backend

On the curent version of this project, the backend is partially being mocked but it is using Supabase for initial Auth. You can eather create a simple supabase project for handling credentials or you can use this one. Note that the project WONT START without the propper .env credentials.

Credentials

You can login on the deployed website using the credentials:

email: admin@admin.com
password: admin123

Getting started

1. Clone the repository
   (Recommended) Use nvm for changing your node version to the same one used in the project by running:

   nvm use
   

2. Install the dependencies. (Recommended use of yarn)

   yarn install
   

3. Setup Envs.

   cp .env.example .env
   

   Make sure to fill in the values of the secrets like it was mentioned in the Backend section

4. Run the project with

   yarn dev
   

   Your project should be running in the localhost:5173 (vite's default)