Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micheldslive/dog-and-pony-challenge
Projeto realizado para teste de Front-End.
https://github.com/micheldslive/dog-and-pony-challenge
nextjs radix-ui react-hook-form storybook tailwindcss typescript zod zustand
Last synced: 3 months ago
JSON representation
Projeto realizado para teste de Front-End.
- Host: GitHub
- URL: https://github.com/micheldslive/dog-and-pony-challenge
- Owner: micheldslive
- License: mit
- Created: 2023-08-24T10:06:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-29T00:57:02.000Z (over 1 year ago)
- Last Synced: 2024-07-30T21:09:41.519Z (5 months ago)
- Topics: nextjs, radix-ui, react-hook-form, storybook, tailwindcss, typescript, zod, zustand
- Language: TypeScript
- Homepage: https://dog-and-pony.mi-code.dev/
- Size: 706 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
About •
Techs •
Getting started •
Live demo •
Book Live demo
## About 💻
Project made for Dog and Pony Studios front end challenge.
## Libs 🚀
The project was developed with following libraries:
- **[Next.js](https://nextjs.org)** is the React Web Framework of choice
- Styling with **[TailwindCSS](https://tailwindcss.com)**
- **[Radix UI](https://www.radix-ui.com)** accessible and customizable library
- **[Storybook](https://storybook.js.org/)** to create a domented app library
- **[React Hook Form](https://react-hook-form.com)** to deal with forms
- Modern State Manager with **[Zustand](https://github.com/pmndrs/zustand)**
- Linting with **[Eslint](https://eslint.org)**
- Code formatting with **[Prettier](https://prettier.io)**
- Git hook with **[Husky](https://github.com/typicode/husky)**
- **[Lint Staged](https://github.com/okonet/lint-staged)** to check staged files before commits
- Automated workflow to production with **[GitHub Actions](https://github.com/features/actions)**
- Static Types with **[Typescript](https://www.typescriptlang.org)**
- Runtime schema validation with **[Zod](https://zod.dev)**
- Generate new components with **[plop](https://plopjs.com/)**
## Getting Started 📦
Clone this repository in your local machine:
```bash
git clone https://github.com/micheldslive/dog-and-pony-challenge.git
```
Then move to the project directory
```bash
cd dog-and-pony-challenge
```
Install the project dependencies:
```bash
pnpm i
# or
yarn
```
Run the application locally and open up [local host](http://localhost:3000)
```bash
pnpm dev
# or
yarn dev
```
With Docker properly installed and the repository Cloned, Run the command below:
```bash
docker compose up
```
The main components of the application were documented. To access them in their locale, run the following command:
```bash
pnpm storybook
# or
yarn storybook
```
## Developer 💻
## 🖊️ License
This project is licensed under the MIT License - see the LICENSE page for details.
