README.md

✔️ Opea Frontend Challenge

💻 Sobre

Esse é um projeto feito para resolver o desafio Frontend da Opea.

---

O projeto está disponível para visualização em https://opea-challenge-micode.vercel.app.
A documentação dos componentes está disponível para visualização em https://opea-challenge-book.vercel.app.

---

🚀 Tecnologias

O projeto foi desenvolvido com as seguintes tecnologias:

• NextJS
• Stitches
• TypeScript
• Jest
• React Testing Library
• framer-motion
• Prettier
• Storybook
• Eslint
• husky
• i18next
• sonner
• react-hook-form
• react-input-mask@next
• axios
• @tanstack/react-query
• @faker-js/faker
• commitlint
• plop

---

▶️ Executando o projeto

Siga os seguintes passos para poder utilizar a aplicação em sua máquina.

1. Clone a aplicação em sua máquina local com os seguintes comandos:

git clone https://github.com/micheldslive/opea-challenge.git

2. Depois, vá até o diretório do seu projeto utilizando o comando

cd opea-challenge

3. Instale as dependências:

pnpm i

3. Altere o arquivo .env.example para .env, caso contrário o projeto não funcionará corretamente:

4. Rode sua aplicação em sua conexão local

pnpm dev

---

▶️ Executando o projeto (Docker)

Com o Docker devidamente instalado e o repositório Clonado, altere o arquivo .env.example para .env, caso contrário o projeto não funcionará corretamente, após essa alteração, Execute o comando abaixo:

docker compose up

---

📚 Design System

Os principais componentes da aplicação foram documententados. Para acessá-los em sua máquina, rode o seguinte comando:

pnpm storybook
# ou
yarn storybook

---

📚 Testes

Para realizar os testes rode os seguinte comando

pnpm test
# ou
yarn test

---

💻 Desenvolvedor

Michel Domingos

🖊️ Licença

O projeto é licenciado sobre a "MIT License" - Veja a pagina LICENÇA para mais destalhes.