README.md

Next Level Week #2

Sobre   |    Tecnologias   |    Como Executar   |    Licença

🔖 Sobre

O Proffy é uma plataforma de estudos online para conectar alunos e professores de forma rápida, fácil e prática. No qual os professores tem a possibilidade de registrar aulas, podendo adicionar informações como a disciplina, o custo e horário e aos alunos a possibilidade de buscar pelas aulas cadastradas e entrar em contato com os "proffys" por WhatsApp.

Essa aplicação foi realizada durante a Next Level Week #2, projeto da Rocketseat.

📌 Etapas

• server ✅

• web ✅

• mobile ✅

🚀 Tecnologias

• Node.js
• Express
• Knex.JS
• ReactJS
• React Native
• Expo
• Typescript
• axios

🌟 Como Executar

• Pré-requisitos

  • É necessário possuir o Node.js instalado no computador
  • É necessário possuir o Git instalado e configurado no computador
  • Também, é preciso ter um gerenciador de pacotes seja o NPM ou Yarn.

1. Faça um clone do repositório:

  $ git clone https://github.com/mauricio-msp/proffy.git

2. Executando a Aplicação (Back-end):

  $ cd server
  # Instalando as dependências do projeto.
  $ yarn # ou npm install
  # Configurando o banco de dados e criando as tabelas.
  $ yarn knex:migrate # ou npm run knex:migrate
  # Inicie a API
  $ yarn start # ou npm start

3. Executando a Aplicação (Front-end):

  $ cd web
  # Instalando as dependências do projeto.
  $ yarn # ou npm install
  # Inicie a aplicação web
  $ yarn start # ou npm start

4. Executando a Aplicação (Mobile):

  $ cd mobile
  # Instalando as dependências do projeto.
  $ yarn # ou npm install
  # Inicie a aplicação mobile
  $ yarn start # ou npm start

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

^{Projeto desenvolvido com a tutoria de Diego Fernandes, da Rocketseat.}