Skip to content
This repository has been archived by the owner on Sep 8, 2021. It is now read-only.

Latest commit

 

History

History
63 lines (41 loc) · 3.05 KB

README.md

File metadata and controls

63 lines (41 loc) · 3.05 KB


PRACTICE Enquete

O PRACTICE Enquete tem como objetivo fornecer à comunidade acadêmica o serviço de criação de formulários e enquetes interativos e dinâmicos de forma ágil e simples, possibilitando responder via link ou QR-Code e assistir a evolução dos resultados em tempo real. O principal diferencial é que a criação das enquetes será muito prática: o usuário escreve um pequeno texto que é automaticamente interpretado e transformado em um lindo e maravilhoso formulário.

IMPORTANTE: este projeto não possui fins lucrativos.

Tecnologias utilizadas

Em resumo, as tecnologias uilizadas tanto no client como no server são as seguir:

  • Docker - Para criação e gerenciamento dos bancos de dados
  • PostgreSQL - Para armazenar e gerenciar todos os dados
  • Node.js 15.8.0 - Para executar client e server (instalar via nvm)
  • Typescript - Para tornar o JavaScript ainda mais poderoso e rápido de utilizar
  • GraphQL - Para criar e utilizar endpoints interativos, dinâmicos e robustos

Executanto a API

Antes de executar a API, é necessário iniciar os bancos de dados utilizando o Docker. Isso pode ser feito a partir da pasta raiz do projeto conforme é mostrado logo abaixo:

docker-compose up -d

Após isso, é possível rodar a API utilizando os comandos abaixo:

cd server
npm install
npm start

Para mais informações específicas do server, clique aqui.

Executanto o client

cd client
npm install
npm start

Para mais informações específicas do client, clique aqui.

Contribua

Sua ajuda é muito bem-vinda, independente da forma! Confira o arquivo CONTRIBUTING.md para conhecer todas as formas de contribuir com o projeto. Por exemplo, sugerir uma nova funcionalidade, reportar um problema/bug, enviar um pull request, ou simplemente utilizar o projeto e comentar sua experiência.

Veja o arquivo ROADMAP.md para ter uma ideia de como o projeto deve evoluir.

Licença

Esse projeto é licenciado nos termos da licença open-source Apache 2.0 e está disponível de graça.

Changelog

Veja todas as alterações desse projeto no arquivo CHANGELOG.md.