Skip to content

Latest commit

 

History

History
349 lines (228 loc) · 12.1 KB

README.md

File metadata and controls

349 lines (228 loc) · 12.1 KB
Raw

Proffy Banner

📚 Proffy é um projeto Open Source desenvolvido na semana Next Level Week (2.0) da Rocketseat utilizando as tecnologias TypeScript, Node, React e React Native.

Tela Web-Mobile



🚀 OBJETIVO

O projeto tem como finalidade estabelecer uma conexão entre os professores (Proffys) e os alunos que desejam um professor com qualificação para dar orientações e aulas sobre determinada matéria. Solucionando então um problema de comunicação entre professores que queiram dar aulas, e alunos que desejam um professor para orientar nos estudos em diversas áreas.

💻 TECNOLOGIAS

📟 Website (React + TypeScript)

Arquivo json do fron-end do webSite package.json

💾 Server (NodeJS + TypeScript)

Arquivo json do Back-end package.json

📱 Mobile (React Native + TypeScript)

Arquivo json do front-end mobile package.json

Utilitários

🍷 COMO UTILIZAR

Configurações Iniciais

Primeiro, você precisa ter o NodeJS instalado na sua máquina.

Se você estiver utilizando o Linux, você pode optar por instalar o Node através do gerênciador de versões asdf para facilitar o processo de mudança da versão do Node, quando for necessário.

Você pode optar também por utilizar o yarn no lugar do npm. Você pode instalar clicando nesse link, ou através do asdf.

Após ter o Node instalado, instale as dependências do React e React Native (Expo) de forma global, utilizando os comandos:

# React:
$ npm install create-react-app -g

# Expo (React Native):
$ npm install -g expo-cli

Você precisa renomear o arquivo .env-example para .env e inserir as informações que condizem com o seu host:

$ mv .env-example .env

Instale as dependências contidas nos arquivos package.json que se encontram na raíz do repositório (para o gerenciamento de commits), no diretório do server, no diretório do website e no diretório mobile. Para instalar as dependências, basta abrir o terminal no diretório e digitar o comando:

$ npm install

# ou
$ yarn

Exemplos:

# Instalando as dependências do commitlint:
$ cd ./proffy
$ npm install

# Instalando as dependências do server:
$ cd ./sources/server
$ npm install

# Instalando as dependências do website:
$ cd ./sources/website
$ npm install

# Instalando as dependências do mobile:
$ cd ./sources/mobile
$ npm install

Veja os arquivos package.json do commitlint, server, website e mobile.

Utilizando o Server

# Abrindo o terminal no diretório do servidor:
$ cd ./sources/server

# Executando a aplicação em modo de desenvolvimento:
$ npm run dev

# Instanciando o banco de dados:
$ npm run knex:migrate

# Povoando o banco de dados (seeds):
$ npm run knex:seed

Veja a parte de scripts {} do arquivo package.json para saber quais scripts estão disponíveis.

Utilizando o Website

# Abrindo o terminal no diretório do website:
$ cd ./sources/website

# Executando o website no modo de desenvolvimento:
$ npm run start

Se o browser não abrir automaticamente, acesse: http://localhost:3000.

Utilizando o Mobile

Instale o aplicativo Expo no seu smartphone.

# Abrindo o terminal no diretório do mobile:
$ cd ./sources/mobile

# Executando o mobile no modo de desenvolvimento:
$ npm run start

Agora, abra o aplicativo do expo e no modo LAN faça o scan do QRCode.

Se tiver algum problema para executar o aplicativo nesse modo, tente desabilitar o firewall da sua máquina.

Se tiver algum problema com as fontes, utilize o comando:

$ expo install expo-font @expo-google-fonts/archivo @expo-google-fonts/poopins

* Lembre de inserir no arquivo .env o IP exato que foi gerado pelo seu mobile após utilizar o comando npm run start.

🌟 AGRADECIMENTOS

Next Level Week Rocketseat diego3g maykbrito

📚 REFERÊNCIAS

📃 LICENÇA

Este repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.

Feito com ❤️ por Luiz Carlos Vilela