README.md

🎒 Proffy é uma plataforma de estudos que conecta professores com alunos

Executar • Design • Tecnologias • Deploy • Licença

💻 Executar

Antes de executar o projeto localmente é preciso instalar algumas ferramentas de desenvolvimento:

• Git
• Yarn
• Node.js (é instalado automaticamente pelo Yarn)

Após a instalação colone esse repositório executando:

$ git clone https://github.com/RenanArques/proffy.git

Aplicação Web

No diretório web execute os comandos:

# Instale os pacotes necessários
$ yarn

# Execute a aplicação web
$ yarn start

API

No diretório server execute os comandos:

# Instale os pacotes necessários
$ yarn

# Execute as migrations do banco de dados SQLite
$ yarn knex:migrate

# Execute a API
$ yarn start

Aplicação Mobile

O Expo CLI é necessário para executar a aplicação mobile para instalar execute o comando:

$ npm install --global expo-cli

No diretório mobile execute os comandos:

# Instale os pacotes necessários
$ yarn

# Execute a aplicação mobile
$ yarn start

🎨 Design

O design da aplicação foi desenvolvido no Figma pela Rocketseat e pode ser acessado através dos links abaixo:

• Web
• Mobile

📖 Tecnologias

As principais ferramentas utilizadas no desenvolvimento do projeto

Aplicação Web

• TypeScript
• React
• Create React App
• React Router

API

• Node.js
• Express
• Knex.js

Banco de Dados

• SQLite

Aplicação Mobile

• React Native
• Expo
• React Navigation

🚀 Deploy

Aplicação Web

A aplicação web foi hospedada no Netlify com o endereço https://proffy-nlw2.netlify.app, usa o diretório web com build e deploys automáticos habilitados e histórico disponível.

API

🚧 Ainda não realizado... 🚧

Aplicação Mobile

🚧 Ainda não realizado... 🚧

📝 Licença

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