Proffy Web 📟

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

Telas Web 📟

Responsividade Web 📟

🚀 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)

• React Router Dom
• React Icons
• Axios
• Leaflet
• React Leaflet
• React Dropzone

Arquivo json do fron-end do webSite package.json

Utilitários

• Protótipo: Figma → Protótipo (Proffy)
• Editor: Visual Studio Code → Extensions: SQLite
• Markdown: StackEdit, Markdown Emoji
• Commit Conventional: Commitlint
• Teste de API: Insomnia
• Ícones: Feather Icons, Font Awesome
• Fontes: Archivo, Poopins

🍷 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 de forma global, utilizando os comandos:

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

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 website. 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 website:
$ cd ./sources/website
$ npm install

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

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.

🌟 AGRADECIMENTOS

Next Level Week	Rocketseat	diego3g	maykbrito

📚 REFERÊNCIAS

• React + TypeScript Cheat Sheet
• Blog Rocketseat
• ReactJS | ReactJS pt-BR
• TypeScript
• React Native
• Expo
• [Knex][knex]
• Express
• Node
• Celebrate
• Joi

📃 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