ialexanderbrito/proffy

🚀 Projeto da 2ª Next Level Week da @Rocketseat

A sua plataforma de estudos online 👨🏾‍🏫 👨🏾‍🎓

🚀 Tecnologias usadas

Esse projeto foi desenvolvido com as seguintes tecnologias:

• Node.js
• Expo
• ReactJS
• TypeScript
• React Native

Extras:

• Main Libs

  • Styled Components
  • Express
  • KnexJS
  • SQLite3
  • CORS
  • React Toggle
  • React Icons
  • Toastify
  • Axios
  • React Picker Select
  • Expo Google Fonts

• Estilos

  • EditorConfig
  • ESLint
  • Prettier

💻 Demo Web

Visite o site

📱 App

Android

💻 Projeto

Proffy é uma plataforma de estudos onlines para alunos encontrarem professores de diversas matérias para focar nos estudos de forma online.

⚙ Como rodar este projeto

Podemos considerar este projeto como sendo divido em três partes:

1. Backend
2. Frontend
3. Mobile

💡 Tanto o Frontend quanto o Mobile precisam que o Backend esteja sendo executado para funcionar.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:

Git

Node.js

E também será preciso um editor, eu indico o VSCode

🧭 Rodando o Backend

# Clone este repositório
$ git clone https://github.com/ialexanderbrito/proffy

# Acesse a pasta do projeto no terminal/cmd
$ cd proffy

# Vá para a pasta Backend
$ cd backend

# Instale as dependências
$ npm install ou yarn

# Execute a aplicação em modo de desenvolvimento
$ npm start ou yarn start

# Se quiser criei uma nova database (opcional)
# Antes remova database da pasta: src/database/database.sqlite e execute:
$ npm knex:migrate ou yarn knex:migrate

# O servidor inciará na porta:3333 - acesse http://localhost:3333 

🧭 Rodando o Frontend

# Clone este repositório
$ git clone https://github.com/ialexanderbrito/proffy

# Acesse a pasta do projeto no seu terminal/cmd
$ cd proffy

# Vá para a pasta da aplicação FrontEnd
$ cd frontend

# Instale as dependências
$ npm install ou yarn

# Execute a aplicação
$ npm start ou yarn start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

🧭 Rodando o Mobile

# Clone este repositório
$ git clone https://github.com/ialexanderbrito/proffy

# Acesse a pasta do projeto no seu terminal/cmd
$ cd proffy

# Vá para a pasta da aplicação Mobile
$ cd mobile

# Instale as dependências
$ npm install ou yarn

# Execute a aplicação
$ expo start ou yarn start

# A aplicação será aberta no navegador basta acessar via QR Code pelo celular

♻️ Como contribuir

• Fork esse repositório;
• Crie uma branch com a sua feature: git checkout -b my-feature
• Commit suas mudanças: git commit -m 'feat: My new feature'
• Push a sua branch: git push origin my-feature

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

🎓 Quem ministrou?

A Next Level Week foi ministrada pelo Diego Fernandes

📝 Licença

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

📱 Social

Me acompanhe nas minhas redes sociais.

---

Feito com ❤️ by Alexander 🤙🏾