https://github.com/vinidevsantos/proffy
NLW#2 - Next Level Week - By Rocketseat
https://github.com/vinidevsantos/proffy
nextlevelweek nextlevelweek-booster nlw nlw-booster nlw-proffy nlw2 proffy rocketseat
Last synced: about 1 year ago
JSON representation
NLW#2 - Next Level Week - By Rocketseat
- Host: GitHub
- URL: https://github.com/vinidevsantos/proffy
- Owner: Vinidevsantos
- Created: 2020-08-04T17:19:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T22:31:43.000Z (over 3 years ago)
- Last Synced: 2025-03-24T20:11:48.047Z (about 1 year ago)
- Topics: nextlevelweek, nextlevelweek-booster, nlw, nlw-booster, nlw-proffy, nlw2, proffy, rocketseat
- Language: TypeScript
- Homepage: https://proffy-mauve-omega.vercel.app/
- Size: 50.8 MB
- Stars: 16
- Watchers: 1
- Forks: 4
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ❔ 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/2/edicao/2)
## 📸 Screenshots
Interface Web para Desktop
## 🛠 Techs
Proffy foi construído com as seguintes techs:
- [React](https://pt-br.reactjs.org/)
- [Typescript](https://www.typescriptlang.org/)
- [Node.js](https://nodejs.org/en/)
## ⚙ Instalação e Start
Para instalar e startar a plataforma Proffy em seu ambiente, siga os passos abaixo:
### Instalação
Clone o repositório:
```
git clone https://github.com/vinidevsantos/proffy.git
```
### Start
Entre no repositório clonado e em seu diretório correspondente ao projeto web (somente interface web no momento):
```
cd ./proffy/web
```
Instale as dependências e starte 🚀
##### NPM
```bash
# Instala todas as dependências
> npm install
# Starta o servidor web para a plataforma Proffy
> npm start
```
##### YARN
```bash
# Instala todas as dependências
> yarn install
# Starta o servidor web para a plataforma Proffy
> yarn start
```
## 🤝 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 ⭐
Feito com ❤️ por Vinicius Santos 👋🏽 Entre em contato!
[](https://twitter.com/ViniSantosDev)
[](https://www.linkedin.com/in/vinidevsantos/)
[](mailto:santosvini.rv@gmail.com)

[](https://github.com/anuraghazra/github-readme-stats)
[](https://github.com/anuraghazra/github-readme-stats)