Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matheusfelipeog/proffy
Plataforma de estudos online para conectar alunos e professores de forma rápida e fácil. @rocketseat
https://github.com/matheusfelipeog/proffy
event express next-level-week next-level-week-2 nlw nlw-2 nodejs omnistack proffy projeto react rocketseat typescript
Last synced: 3 days ago
JSON representation
Plataforma de estudos online para conectar alunos e professores de forma rápida e fácil. @rocketseat
- Host: GitHub
- URL: https://github.com/matheusfelipeog/proffy
- Owner: matheusfelipeog
- License: mit
- Created: 2020-08-04T16:41:47.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-25T07:52:53.000Z (over 2 years ago)
- Last Synced: 2024-09-20T12:14:56.723Z (7 days ago)
- Topics: event, express, next-level-week, next-level-week-2, nlw, nlw-2, nodejs, omnistack, proffy, projeto, react, rocketseat, typescript
- Language: TypeScript
- Homepage:
- Size: 900 KB
- Stars: 22
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 📌 Index
- [Sobre o projeto](#-sobre-o-projeto)
- [Screenshots](#-screenshots)
- [Techs](#-techs)
- [Instalação e Start](#-instalação-e-start)
- [Clonagem](#clonagem)
- [Web](#web)
- [Server](#server)
- [Contribuições](#-contribuições)
- [License](#-license)
## ❔ Sobre o projeto
Uma plataforma de estudos online que visa conectar alunos e professores de forma rápida e fácil.
O projeto está sendo desenvolvido na [Next Level Week 2](https://nextlevelweek.com/episodios/omnistack/1/edicao/2)
## 📸 Screenshots
Interface Web para Desktop
Interface Web para Mobile
## 🛠 Techs
Proffy foi construído com as seguintes techs:
- Web
- [React](https://pt-br.reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- Server
- [Node.js](https://nodejs.org/en/)
- [Express](https://expressjs.com/)
- [Knex](http://knexjs.org/)
- Banco de Dados
- [Sqlite3](https://www.sqlite.org/index.html)
## ⚙ Instalação e Start
Certifique-se de que tenha o `Node.js` e um gerenciador de dependências em seu ambiente antes de seguir os passos abaixo.
Para instalar e startar a plataforma Proffy, use `npm` ou `yarn`:
### Clonagem
Primeiro, clone o repositório para seu ambiente:
```bash
> git clone https://github.com/matheusfelipeog/proffy.git
```
Depois, entre no repositório clonado e no diretório correspondente ao que quer testar (web, server).
Logo após, insira os seguintes comandos no seu terminal para cada diretório respectivamente:
### Web
```bash
# Entra no diretório "web"
> cd ./proffy/web
# Instala todas as dependências
> yarn install
# Starta o servidor web para a plataforma Proffy
> yarn start
```
Será startado em `http://localhost:3000`
### Server
```bash
# Entra no diretório "server"
> cd ./proffy/server
# Instala todas as dependências
> yarn install
# Starta o servidor web para a plataforma Proffy
> yarn start
```
Será startado em `http://localhost:5000`
## 🤝 Contribuições
Siga os passos abaixo para contribuir:
1. Faça o *fork* do projeto ()
2. Clone o seu *fork* para sua maquína (`git clone https://github.com/user_name/proffy.git`)
3. Crie uma *branch* para realizar sua modificação (`git checkout -b feature/name_new_feature`)
4. Adicione suas modificações e faça o *commit* (`git commit -m "Descreva sua modificação"`)
5. *Push* (`git push origin feature/name_new_feature`)
6. Crie um novo *Pull Request*
7. Pronto, agora só aguardar a análise 🚀
## 📜 License
O projeto está sobre a licença [MIT](./LICENSE) ❤️
Gostou? Deixe uma estrelinha para ajudar o projeto ⭐