/Proff-Nlw

Projeto desenvolvido na semana Next Level Week

Primary LanguageTypeScript

logo

🚧 Proff🚀 concluído 🚧


Sobre o projeto • Funcionalidades • Layout • Como executar o projeto • Tecnologias • Contribuidores • Autor • Licença •


Sobre o projeto

Em meio a pandemia muitas áreas sofreram mudanças extremas e a educação foi uma delas que mais sofreu mudanças como a forma de realizar as aulas e o contato com professores. O sistema Proffy, permite você encontrar diversos professores on-line, que oferecem aulas particulares e com horários flexíveis servindo como um reforço em meio a pandemia.

Projeto desenvolvido durante a semana Next Level Week - NLW 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.


Funcionalidades

  • Cadastrar professores.
  • Buscar Professores por:
    • Matéria;
    • Dia da Semana;
    • Horário.
  • Listar professores.
  • Exibe informações sobre o professor.

Layout

Você pode acessar os Layout pelo Figma:

Mobile: neste link.

Web: neste link.


Versão Mobile

proff

Versão web

proff
proff
proff

Como executar o projeto

Este projeto é divido em três partes:

  1. Backend (pasta backend)
  2. Frontend (pasta web)
  3. Mobile (pasta mobile)

Tanto o Frontend quanto o Mobile precisam que o Backend esteja sendo executado para funcionar.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git é um editor para trabalhar com o código como VSCode

🎲Clonando o projeto

# Clone este repositório
$ git clone git@github.com:andersonzeroone/Proff-Nlw.git

# Acesse a pasta do projeto no terminal/cmd
$ cd Proff-Nlw

🎲 Rodando o Backend (servidor)

# Acesse a pasta do projeto no terminal/cmd
$ cd backend

# Instale as dependências
$ npm install ou yarn install

# Execute a aplicação
$ npm start ou  yarn start 

# O servidor iniciará na porta:3333 - acesse http://localhost:3333

🧭 Rodando a aplicação web (Frontend)

# Vá para a pasta da aplicação Front End
$ cd web

# Instale as dependências
$ npm install ou yarn install

# Execute a aplicação em modo de desenvolvimento
$ npm start ou  yarn start 

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

🧭 Rodando a aplicação mobile

# Vá para a pasta da aplicação Front End
$ cd mobile

# Instale as dependências
$ npm install ou yarn install

# Execute a aplicação em modo de desenvolvimento
$ expo start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

acesse localhost:19002, leia o QR Code no seu celular e utilize o aplicativo Expo para rodar a versão mobile no seu smartphone. Ou com algum emulador Android/iOS para rodar no seu computador.

Tecnologias

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

Backend (NodeJS + TypeScript)

See the file package.json

Website (React + TypeScript)

See the file package.json

Mobile (React Native + TypeScript)

Veja o arquivo package.json

Utilitários

Contribuidores

💜 Um super thanks 👏 para essa galera que fez esse produto sair do campo da ideia e entrar nas lojas de aplicativos :)

Como contribuir para o projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
  4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

Autor




Anderson Pablo 🚀

Linkedin Badge Gmail Badge

Licença

Este projeto está sob a licença MIT.

Feito com ❤️ por Anderson Pablo 👋🏽 Entre em contato!