README.md

NLW_PROFFY: Marques de Souza

Indice / Summary

• Sobre o NLW/Introduce in NLW
• Sobre/ Introduce
• Tecnologias Utilizadas/List Technologies
• Contributing/Contribuir
• Versioning/Versionamento
• History/Históric
• License/Licença do Projeto
• Como baixar o projeto

---

💜 Sobre NLW

O Next Level Week criado pela Rocketseat, é uma semana focada na prática, criando uma aplicação do total zero e completa, sendo o back-end, front-end e mobile. Utilizando apenas uma linguagem de programação, o JavaScript. Ao longo dessa semana são passados alguns "hacks" da programação para facilitar e encurtar a distância até o seu próximo nível. Confira abaixo mais detalhes sobre essa semana.

📖 Sobre

O projeto Proffy é uma plataforma de estudos online onde conseguimos conectar alunos e professores para termos a conexão entre eles. Exibindo através de filtros, quais os horários disponíveis de cada professor e a matéria que ele leciona. Esse app é separado em duas páginas basicamente, a página de dar aulas e de estudar.

Um conceito novo que utilizamos nesse NLW é o Mobile First, primeiramente construímos essa interface para dispositivos móveis e então adaptamos para telas maiores.

Para o desenvolvimento desse projeto foi utilizado TypeScript. Além das bibliotecas de padronização de código ESLint, Prettier e EditorConfig e para estilização styled-components tanto para o web e mobile.

🚀 Tecnologias utilizadas

Ao longo do desenvolvimento do projeto foram utilizados as seguintes tecnologias:

• ESLint
• Prettier
• TypeScript
• styled-components
• axios
• react-router-dom
• react-icons
• Express
• knex
• cors
• sqlite3
• expo

---

📢 Contributing/Contribuir

Entre em contato por Email ou Linkeding Quer contribuir com o projeto? Confira o passo a passo Quer ver o que está por vir? Acompanhe aqui

Versioning/Versionamento

Esse projeto não possui um sistema de versionamento.

---

📚 History/Histórico

Da uma olhada na aba Releases pra acompanhar as alterações feitas no projeto.

---

📑 License/Licença do Projeto

MIT License © Marques de Souza

---

💻 Como baixar o projeto

Back-end

  # Clonar repositório
  $ git clone https://github.com/MarquesSouza/NLW_PROFFY

  # Entrar no diretório
  $ cd server

  # Instalar as dependências via yarn
  $ yarn

  # Instalar as dependências via npm
  $ npm install

  # Iniciar o projeto
  $ yarn dev

---

Front-end

  # Clonar repositório
  $ git clone https://github.com/MarquesSouza/NLW_PROFFY

  # Entrar no diretório
  $ cd web

  # Instalar as dependências via yarn
  $ yarn

  # Instalar as dependências via npm
  $ npm install

  # Iniciar o projeto
  $ yarn start

---

Mobile

  # Clonar repositório
  $ git clone https://github.com/MarquesSouza/NLW_PROFFY

  # Entrar no diretório
  $ cd mobile

  # Instalar as dependências via yarn
  $ yarn

  # Instalar as dependências via npm
  $ npm install

  # Iniciar o projeto
  $ yarn start

  # Verificar o IP do Emulador/Celular físico para poder receber os dados vindo do back-end

---