/NLW-2

Fictional platform developed during an event.

Primary LanguageCSSMIT LicenseMIT

GitHub language count Repository size GitHub last commit By Kauan Schaeffer NextLevelWeek#2 License

Project language Swap readme language

Proffy-Banner

🚧 Proffy 👨‍🏫 Concluído ✔️ 🚧

SobreFuncionalidadesLayoutPreviewExecutandoTecnologiasLicença

💻 Sobre o projeto

Projeto desenvolvido durante a NLW #2- Next Level Week 2 oferecida pela Rocketseat. O NLW é uma experiência online com muito conteúdo prático, desafios e hacks onde o conteúdo fica disponível durante uma semana.

👨‍🏫 Proffy - O projeto surgiu com a missão de trazer uma homenagem aos educadores do Brasil, através de uma plataforma que conecta alunos e professores de diversas matérias. Todo o desenvolvimento foi feito na semana do dia nacional dos profissionais de educação.
A mim este projeto teve o caráter fundamental de reforçar as bases do desenvolvimento front-end, principalmente com HTML e CSS.


⚙️ Funcionalidades

  • Professores podem se cadastrar na plataforma através de um formulário no qual preenchem seus dados:

    • nome completo
    • link de uma foto
    • número de whatsapp
    • breve biografia
    • matéria que será lecionada
    • custo hora/aula
    • horários disponíveis
  • Alunos podem buscar professores e:

    • filtrar por matéria, dia da semana e horário
    • entrar em contato diretamente no whatsapp de determinado professor

🎨 Layout

Figma layout

Web

Web Homepage Web Give-classes page

Mobile

Mobile preview


📺 Preview

Preview


🚀 Como executar o projeto

Este projeto consiste em três partes:

  1. Frontend
  2. Backend
  3. Database

Pré-requisitos

🎲 Rodando o projeto

# Clone o repositório
$ git clone https://github.com/K-Schaeffer/NLW-2.git

# Acesse a pasta do projeto no prompt de comando
$ cd NLW-2

# Instale as dependências
$ npm install

# Execute o script "dev"
$ npm run dev

# O projeto inciará na porta: 3000 - acesse http://localhost:3000 

Opcionalmente, você pode desejar ter uma base de dados limpa, para isso:

# Delete o arquivo database.sqlite
$ rm -r src/database/database.sqlite

# Execute o arquivo para criação das tabelas
$ node src/database/db.js

Feito isso, basta executar o procedimento de rodar o projeto, cadastrar professores, e buscá-los ;)


🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Front-end (HTML + CSS + JS)

Back-end (NodeJS)

Veja o arquivo package.json

Database (Sqlite-Async)

Utilitários

📝 Licença

Este projeto está sob a licença MIT.


Feito com ❤️ por Kauan Schaeffer 👋 Entre em contato :)