https://github.com/jefferson-calmon/proffy

Plataforma de estudos online :book:
https://github.com/jefferson-calmon/proffy

Last synced: about 5 hours ago
JSON representation

Plataforma de estudos online :book:

• Host: GitHub
• URL: https://github.com/jefferson-calmon/proffy
• Owner: jefferson-calmon
• Created: 2020-08-03T22:13:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T03:34:13.000Z (almost 2 years ago)
• Last Synced: 2023-03-07T16:05:46.147Z (over 1 year ago)
• Language: TypeScript
• Size: 1.92 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 31
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    


    
A sua plataforma de estudos online.

    





    















 













## :scroll: Sobre o projeto

O Proffy é uma plataforma de estudos online criada durante o Next Level Week #2. O NLW é um evento disponibilizado pela rocketseat que visa levar os devs para um próximo nível.

## :gear: Requisitos

- [Node.js](https://nodejs.org/en/)

- [Expo](https://docs.expo.io/)

- [GIT](https://git-scm.com/)

## :artificial_satellite: Tecnologias

Para desenvolver este projeto utilizamos as seguintes tecnologias:

- ReactJS - Front-End

    - React Router Dom

    - Axios

- NodeJS - Back-End

    - Express

    - Knex

    - Sqlite3

- React Native - Mobile

    - Expo

    - Expo Fonts

Projeto todo criado utilizando Typescript.

## :rocket: Utilização

**[Acessar plataforma web](https://proffy-app.netlify.app/).**

**[Baixar aplicativo mobile](https://proffy-app.netlify.app/app/)**

ou

### Rodar projeto localmente

#### Front-End - Web

1. Clone este repositório com ```git clone https://github.com/jefferson-calmon/proffy.git```

1. Acesse a pasta do projeto com ```cd proffy```

1. Instale as dependências do projeto com ```npm install``` ou ```yarn install```

1. Inicie o projeto com ````npm start``` ou ```yarn start```

1. Caso não abra um página web em seu navegador, acesse ```http://localhost:3000```

#### Back-End

1. Se você não clonou este respositório ainda, clone ele seguindo o 1° passo do front-end.

1. Acesse a pasta ```server```

1. Rode ```npm install``` ou ```yarn install``` para instalar as dependências do projeto.

1. Rode ```npm start``` ou ```yarn start``` para iniciar servidor local.

##### Rotas

- [GET] /connections => Exibe conexões já realizadas

- [GET] /classes => Exibe professores já cadastrados na plataforma. Obs: necessita de query params.

#### Mobile

1. Acesse a pasta ```mobile``` do projeto.

1. Rode ```npm install``` ou ```yarn install``` para instalar as dependências

1. Inicie o projeto com ````npm start``` ou ```yarn start```

1. Caso não abra um página web em seu navegador, acesse ```http://localhost:3000```

## :thinking: Como contribuir

- Faça um fork desse repositório;

- Cria uma branch com a sua feature: `git checkout -b minha-feature`;

- Faça commit das suas alterações: `git commit -m 'feat: Minha nova feature'`;

- Faça push para a sua branch: `git push origin minha-feature`.

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

## :technologist: Dev

Jovem apaixonado por programação e desenvolvimento, Jefferson ferrari é um desenvolvedor front-end.

[Portfólio](https://jefferson-calmon.github.io)

[Linkedin](https://www.linkedin.com/in/jefferson-f-b24248191/)

[Instagram](https://instagram.com/jeffz1_)

---

Build with :heart: