Penshare é uma plataforma de edição de textos de forma colaborativa, facilitando o desenvolvimento de trabalhos em grupos de estudos remotos.

💻 Desenvolvimento

• Clone o repositório

  • git clone https://github.com/rodrigofazenda/penshare.git

• Instale as dependências

  • cd penshare && npm install
  • cd react-ui && npm install

• Para executar o projeto:

  • Backend: raiz do projeto (./package.json): npm start
  • Frontend: (react-ui/package.json): npm start

Nota: é necessário adicionar os arquivos das variáveis de ambiente, favor falar com Rodrigo Fazenda

🐛 Bug / Melhorias

Se você encontrou um bug (resultados inesperados, erros de digitação, etc), por favor abrir uma issue aqui com os passos para reproduzir o bug e o comportamento esperado.

Se você tem uma sugestão de melhoria para o projeto, favor abrir uma nova issue aqui. Favor detalhar bem os resultados esperados.

🔨 Construído com:

• Node - Pré-requisito para rodar o projeto.
• PostgreSQL - Banco de dados. Pré requisito.
• React - Biblioteca para Front-End.
• Express - Framework para Back-End.

🚧 To-do

• No Trello 😁