proffy
👨🏫🧑🎓 Projeto Open Source desenvolvido utilizando React, Node e React Native, de uma plataforma de estudos online, onde conseguimos conectar alunos e professores para ter aulas online.
MIT License
Projeto Open Source desenvolvido na #NextLevelWeek da Rocketseat, utilizando TypeScript, React, React Native e Node.
🚀 OBJETIVO
O objetivo do projeto criar uma plataforma de estudos, onde conseguimos conectar alunos e professores para realizarem aulas online.
📝 DESENVOLVIMENTO
💻 TECNOLOGIAS
Website (React + TypeScript)
* Veja o arquivo package.json do projeto Web.
Server (NodeJS + TypeScript)
* Veja o arquivo package.json do projeto Server.
Mobile (Expo + TypeScript)
* Veja o arquivo package.json do projeto Mobile.
Utilitrios
- Prottipo: Figma | Prottipo(Web) | Prottipo(Mobile) |
- Editor: Visual Studio Code → Extensions: VSCode_Plugin_SQLite
- Markdown: StackEdit
- Commit Conventional: Commitlint
- Teste de API: Insomnia
- Fontes: Google Fonts - Archivo | Google Fonts - Poppins
- Emojis: Emojipedia | Markdown Emoji
- Wireframe Editor: Whimsical
- Anotaes / Checklist: Notion
- cones: Ionicons | Feather Icons
🔧 CONFIGURAO DO AMBIENTE
Veja o arquivo de configurao do ambiente para saber como configurar corretamente a sua mquina para utilizar o projeto.
🍷 COMO UTILIZAR
Utilizando o Web
# Abrindo o diretrio Web no terminal:
$ cd ./packages/web
# Instalando as dependncias do package.json:
$ yarn
# Iniciando o projeto utilizando o script 'start' do package.json:
$ yarn start
O projeto ser aberto em
http://localhost:3000;
Utilizando o Server
Voc precisa renomear o arquivo .env-example para .env e inserir as informaes que condizem com o seu host:
$ cd ./packages/server
$ mv .env-example .env
# Abrindo o diretrio do Server no terminal:
$ cd ./packages/server
# Instalando as dependncias contidas no package.json:
$ yarn
# Iniciando o Server utilizando o script 'start' do package.json:
$ yarn start
# Instanciando as tabelas do banco de dados:
$ yarn knex:migrate
# Voltando a ltima alterao feita na tabela:
$ yarn knex:migrate:rollback
Utilizando o Mobile
Instale o aplicativo Expo no seu smartphone.
# Abrindo o terminal no diretrio do mobile:
$ cd ./packages/mobile
# Executando o mobile no modo de desenvolvimento:
$ yarn start
Agora, abra o aplicativo do expo e no modo LAN faa o scan do QRCode.
Se tiver algum problema para executar o aplicativo nesse modo, tente desabilitar o firewall da sua mquina.
:octocat: COMO CONTRIBUIR
Siga as instrues do arquivo como contribuir para contribuir corretamente.
🌟 AGRADECIMENTOS
📚 REFERNCIAS
📃 LICENA
Esse repositrio est licenciado pela MIT LICENSE. Para mais informaes detalhadas, leia o arquivo LICENSE contido nesse repositrio.