micheldslive/pomodoro-app

A pomodoro app using front end mentor layout

POMODORO APP

💻 Sobre

Projeto realizado utilizando layout POMODORO FRONT END MENTOR.

Layout: hhttps://www.frontendmentor.io/challenges/pomodoro-app-KBFnycJ6G.

Clique aqui para abrir o projeto no vercel.

Clique aqui para abrir a documentação dos componentes (storybook)

---

🚀 Tecnologias

O projeto foi desenvolvido com as seguintes tecnologias:

• ViteJS
• TypeScript
• SASS
• Vitest
• React Testing Library
• classnames
• Eslint
• Prettier
• Husky
• Docker
• react-circular-progressbar
• use-sound
• react-hook-form
• storybook

---

▶️ 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/pomodoro-app.git

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

cd pomodoro-app

3. Instale as dependências:

yarn install
# ou
npm install

4. Renomeando .env.example:

renomeie o arquivo .env.example para .env

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

npm run dev
# ou
yarn dev

---

▶️ Executando o projeto (Docker)

Com o Docker devidamente instalado e o repositório Clonado, Execute o comando abaixo:

docker compose up

---

📚 Testes

Para realizar os testes rode os seguinte comando

npm run test
# ou
yarn test

---

💻 Desenvolvedor

Michel Domingos

🖊️ Licença

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