https://github.com/thenameiswiiwin/pet-adoption
https://github.com/thenameiswiiwin/pet-adoption
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thenameiswiiwin/pet-adoption
- Owner: thenameiswiiwin
- Created: 2022-07-21T04:06:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T06:22:30.000Z (almost 3 years ago)
- Last Synced: 2024-05-17T20:18:17.789Z (over 1 year ago)
- Language: JavaScript
- Size: 332 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Tailwindcss Project build with Vite
This is a [ReactJS](https://reactjs.org) + [Vite](https://vitejs.dev) App to be used with [Tailwindcss](https://tailwindcss.com).
This is a complete application to browse adoptable pets.
## Tools
- [ReactJS](https://reactjs.org)
- [Vite](https://vitejs.dev)
- [TypeScript](https://www.typescriptlang.org)
- [Tailwindcss](https://tailwindcss.com)
- [Eslint](https://eslint.org)
- [Airbnb JS Style Guide](https://github.com/airbnb/javascript)
- [Airbnb React Style Guide](https://github.com/airbnb/javascript/tree/master/react)
- [Prettier](https://prettier.io)
- [Husky](https://github.com/typicode/husky)
## Getting Started
### System Requirements
- [git][git] v2.13 or greater
- [NodeJS][node] `14.10+ || 16+`
- [npm][npm] v6 or greater || [yarn][yarn]
All of these must be available in your `PATH`. To verify things are set up
properly, you can run this:
```bash
git --version
node --version
yarn --version
```
### Setup
Clone the project.
```bash
git clone https://github.com/thenameiswiiwin/pet-adoption.git
```
Access the project directory.
```bash
cd pet-adoption
```
Install dependencies.
```bash
yarn
```
### Run in Development Mode
Serve with hot reload at .
```bash
yarn dev || npm run dev
```
### Run ESLint linting
```bash
yarn lint || npm run lint
```
### Run Prettier Formatting
```bash
yarn format || npm run format
```
### Create Production Build
```bash
yarn build || npm run build
```
### Run TypeScript Compiling
```bash
yarn compile
```
### Serve Production Build Locally
```bash
yarn preview
```