marianavns / plataforma-back

Plataforma das Compiladoras

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Plataforma Compiladoras


Tabela de Conteúdos

  1. Principais Features da API
  2. Instruções de uso
  3. Tecnologias Utilizadas

💡 Principais Features da API

  • Visualizar todos os projetos da Plataforma Compiladoras;
  • Visualizar todas as redes sociais da Plataforma Compiladoras;
  • [x]

💻 Instruções de uso

| - Tenha instalados os programas Node.js e PostgreSQL, além de um editor de códigos;
- Clone o projeto: git clone https://github.com/marianavns/plataforma-back
- Dentro da pasta do projeto, digite npm install no cmd para baixar as dependências do projeto;
- Na pasta 'server/infra', renomeie o arquivo database_ENV.js para database.js e insira as variáveis de ambiente pedidas.

- Para as rotas de GET, configuradas por enquanto, você pode usar apenas o navegador :)
|

🛠️ Tecnologias Utilizadas

Para construção da API

  • Node.js, versão 12.18.3;
  • Gerenciador de pacotes node npm, versão 6.14.6;
  • Banco de dados PostgreSQL;
  • Editor de códigos VSCode.

Para uso da API

  • Seu navegador: para teste das funcionalidades GET (rotas) da API;

✔️ Features e Rotas

Manipulando os registros de projetos

Feature Método Rota
Visualizar todos os projetos GET /projects

Manipulando os registros de redes sociais

Feature Método Rota
Visualizar todos as redes sociais GET /social-networks

About

Plataforma das Compiladoras

License:MIT License