virginiarcruz / pet-buddy

Pet Buddy - Animal Shelter Database System, Animal Shelter, Animal System, Shelter Software, Shelter Management

Pet Buddy Project

What is inside?

This project uses:

• TypeScript
• NextJS
• Styled Components
• Jest
• React Testing Library
• Storybook
• Eslint
• Prettier
• Husky

Getting Started

First, clone this repository and install the dependencies:

git clone https://github.com/virginiarcruz/shelter-buddy.git

yarn

So, run the development server:

yarn dev

Open http://localhost:3000 to see the result.

To run a storybook version:

yarn storybook

Open http://localhost:6006 to see the result.

Commands

• yarn dev: runs your application on localhost:3000
• yarn storybook: runs storybook on localhost:6006
• yarn lint: runs the linter in all components and pages
• yarn test:watch: runs jest in watch mode
• yarn test: runs jest to test all components and pages
• yarn build: creates the production build version
• yarn start: starts a simple server with the build production code