📖 Tópicos

👉 Sobre o Projeto
👉 Funcionalidades
👉 Layout
👉 Instalação e Configuração
👉 Tecnologias Utilizadas
👉 Desenvolvedor
👉 Licença

💻 Sobre o projeto

Aplicação para auxiliar o seu gerenciamento de tempo, inspirada pela técnica de pomodoro. Além de incentivar exercícios físicos, alongamentos e exercícios para os olhos durante os intervalos.

Também é implementado elementos de RPG (níveis e ranking global) para te manter motivado.

🍅 O que é a Técnica de Pomodoro?

A técnica de Pomodoro consiste em você dividir seu tempo de estudo e trabalho em pequenos blocos de intervalo, normalmente com duração de 25 minutos e separados por uma curta pausa.

Cada bloco é conhecido como um pomodoro, onde você aplica foco total em sua atividade, após o tempo acabar, você descansa por um breve período, tradicionalmente 5 minutos, e após isso retorna à atividade.

🎲 Como funciona o Break.Timer?

Na páina inicial há um contador regressivo que inicia em 25 minutos para marcar seu tempo de pomodoro.

Após o tempo acabar, iremos te indicar um exercício para realizar, pode ser um alongamento físico ou um relaxamento aos seus olhos. Caso você consiga concluir o desafio, ganhará uma certa quantidade de pontos de experiência.

Conforme você for acumulando experiência, seu nível irá aumentar e você poderá ver sua colocação no ranking global, que inclui todos os usuários do Break.Timer.

O projeto está publicado em:

---

⚙️ Funcionalidades

• Páginas
  • Login
    • Autenticação com GitHub oAuth
  • Principal
    • Experiência
    • Perfil
    • Countdown
    • Desafios
  • Ranking
    • Informações de Todos os Usuários
• Integração com MongoDB
  • Rota para cadastrar novo usuário
  • Rota para buscar usuário existente
  • Rota para atualizar usuário existente
  • Rota para buscar todos usuários existentes
• Logout da Aplicação
• Tema Dark/Light
• Responsivo para Mobile

---

🎨 Layout

Login

Página Principal

Level Up

Ranking

---

🛠 Instalação e Configuração do Projeto

Pré-requisitos

Para executar os comandos, é necessário possuir as seguintes ferramentas instaladas:

Git e Node.js.

Para manipular o código, recomendo utilizar o VSCode.

🎮 Rodando a aplicação web (Frontend)

1. Clone este repositório

   git clone https://github.com/oviniciusoliveira/breaktimer.git

2. Acesse a pasta do projeto no seu terminal

   cd breaktimer

3. Instale as dependências

   npm install

4. Altere o nome do arquivo .env.sample para .env e configure as variáveis de ambiente

5. Execute a aplicação em modo de desenvolvimento

   npm run dev

6. A aplicação será aberta na porta 3000 - Acesse http://localhost:3000

---

🧱 Tecnologias Utilizadas

Website (Next.js + TypeScript)

Front-end hospedado na Vercel

Banco de Dados (MongoDB) hospedado na MongoDB Atlas

Autenticação utilizando GitHub oAuth

Principais Bibliotecas Utilizadas

• React
• Axios
• NextAuth.js

Mais informações no package.json

Ferramentas e utilitários usados durante o desenvolvimento

• Editor: Visual Studio Code
• Testes de API: Insomnia
• Database Manager: MongoDB Compass

Fontes Utilizadas

• Inter
• Rajdhani

---

🐱‍👤 Desenvolvedor

_{⭐Vinícius Oliveira⭐}

---

📝 Licença

Este projeto está sob a licença MIT.

Feito com 💙 por Vinícius Oliveira 👋 Entre em contato!

---