Skip to content

UBB-ONG/api-ubb

Repository files navigation

UBB-API-REST

📕 Índice


Sobre

Api desenvolvida para ong UBB, no momento sendo utilizada apenas para cadastro e consultas de depoimentos, deixando o front-end totalmente dinâmico nessa parte, futuramente esta sendo implementada novas funcionalidades.

Tecnologias


Iniciando

Pré-requisitos
  • Node JS

    https://nodejs.org/en/
  • Yarn ou Npm

    https://yarnpkg.com/
  • PostgresSQL

    https://www.postgresql.org/

Instalação e uso

# Execute este comando para clonar o projeto
$ git clone [email protected]:UBB-ONG/api-ubb.git
# ou use a opção de download.

# Entre na pasta com
$ cd api-ubb

# Instale as dependências
$ yarn ou npm install

# Crie o banco de dados e as tabelas utilizando o comando
$ yarn typeorm migration:run ou npm typeorm migration:run

# Rode a aplicação usando o comando
$ yarn dev ou npm run dev

Documentação: https://ubb-api.herokuapp.com/api-docs

Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Contatos


@WelissonLuca

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •