Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 3.57 KB

README.md

File metadata and controls

74 lines (54 loc) · 3.57 KB

WhatsApp Image 2024-08-05 at 19 31 46

🚀 IntelliGuide - Plataforma de Ensino Gamificada 🎓

Bem-vindo(a) ao IntelliGuide - uma plataforma de aprendizado gamificada que transforma o aprendizado em uma experiência dinâmica e envolvente através de quizzes interativos sobre uma variedade de assuntos.

🛠️ Tecnologias Utilizadas

  • Next.js: Framework React para desenvolvimento de aplicações web.
  • React: Biblioteca JavaScript para criar interfaces de usuário.
  • TypeScript: Superset do JavaScript que adiciona tipagem estática.
  • Prisma: ORM para interagir com o banco de dados de forma eficiente.
  • Tailwind CSS: Framework de CSS utilitário para desenvolvimento rápido.
  • NextAuth.js: Biblioteca para autenticação em Next.js.
  • Zod: Biblioteca para validação de esquemas de dados.
  • Shadcn-UI: Componentes estilizados para uma experiência visualmente atraente.
  • Sonner: Biblioteca para exibição de notificações e toasts.
  • Nodemailer: Biblioteca para envio de emails.
  • Stripe: Plataforma de pagamentos para gerenciar transações financeiras.
  • Zustand: Biblioteca para gerenciamento de estado.

⚙️ Configurações do Projeto

  • ESLint: Configurações padrão para garantir boas práticas de codificação.
  • Prettier: Configurações para manter uma formatação consistente do código.

🤟Principais Recursos

  • 🖥️ Interface Responsiva: Desfrute de uma experiência fluida em qualquer dispositivo, seja desktop, tablet ou smartphone.

  • 📊 Dashboard do Usuário: Os usuários têm acesso a um dashboard completo onde podem gerenciar seus quizzes, progresso e pontuações.

  • 🗓️ Quizzes Interativos: Participe de quizzes interativos e desafiadores para testar e aprimorar seus conhecimentos.

  • 📧 Envio de Email: Utilizamos o Nodemailer para envio de emails, facilitando a comunicação com os usuários da plataforma.

  • 🔐 Autenticação Completa: Implementamos autenticação segura utilizando NextAuth.js, permitindo login com Google e GitHub.

  • 📋 Painel de Administrado: Administradores têm acesso a um painel fácil de usar para adicionar novos desafios e gerenciar o conteúdo da plataforma.

🚀 Como Instalar e Executar o Projeto

  1. Clone este repositório utilizando o comando:
    git clone https://github.com/WesleyR10/intelli-guide.git
  2. Acesse o diretório do projeto:
    cd intelli-guide
  3. Instale as dependências utilizando o npm:
    npm install
  4. Após a instalação das dependências, inicie o servidor de desenvolvimento:
     npm run dev
  5. Execute o docker
     docker-compose up -D
  6. Insira as chaves necessarias no arquivo env.example e depois altere o nome dele para .env
     npm run dev
  7. Abra o navegador e acesse http://localhost:3000 para visualizar o IntelliGuide em ação!

Colaboradores 🤝🤝

Foto Nome
Wesley Ribas
Miquéias Martins
Eduardo Henrique