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: 4 months 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 (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T22:31:43.000Z (about 2 years ago)
• Last Synced: 2024-10-13T08:21:23.086Z (4 months 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: 17
• 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!

[![Twitter Badge](https://img.shields.io/badge/-@ViniSantosDev-1ca0f1?style=flat-square&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/ViniSantosDev)](https://twitter.com/ViniSantosDev)

[![Linkedin Badge](https://img.shields.io/badge/-Vinicius-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/vinidevsantos/)](https://www.linkedin.com/in/vinidevsantos/) 

[![Gmail Badge](https://img.shields.io/badge/[email protected]?style=flat-square&logo=Gmail&logoColor=white&link=mailto:[email protected])](mailto:[email protected])

![GitHub followers](https://img.shields.io/github/followers/vinidevsantos?style=social)

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=vinidevsantos&layout=compact)](https://github.com/anuraghazra/github-readme-stats)

[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=vinidevsantos)](https://github.com/anuraghazra/github-readme-stats)