API-REST-CHURCH

Esta é uma API criada a partir das habilidades desenvolvidas em:

Curso Online de API REST com NODE e TYPESCRIPT do Lucas Souza Dev.

Descrição do Projeto

Esta api foi desenvolvida para que possa ser usada no desenvolvimento de interfaces utilizando javascript e suas bibliotecas/frameworks. Mas pode ser utilizada localmente por quaisquer linguagens e frameworks que desejar.

Rodando localmente

Clone o projeto

  git clone https://github.com/Player35Oficial/api-rest-church.git

Entre no diretório do projeto

  cd api-rest-church

Instale as dependências

  yarn install

Instale e configure o banco de dados

  yarn knex:migrate

Inicie o servidor (port: 3333)

  yarn start

Rodando os testes

Para rodar os testes, rode o seguinte comando

  yarn test

Variáveis de Ambiente

Para rodar esse projeto, você vai precisar adicionar as seguintes variáveis de ambiente no seu .env

PORT

NODE_ENV

IS_LOCALHOST

JWT_SECRET

Documentação

A Documentação pode ser lida ao iniciar o servidor com sucesso através do endpoint: /api-docs. Ex: http://localhost:3333/api-docs

Tecnologias utilizadas

Node.js

Node.js é um software de código aberto, multiplataforma, baseado no interpretador V8 do Google e que permite a execução de códigos JavaScript fora de um navegador web. A principal característica do Node.js é sua arquitetura assíncrona e orientada por eventos.

Typescript

TypeScript é uma linguagem de programação fortemente tipada baseada em JavaScript, oferecendo melhores ferramentas em qualquer escala.

Knex.js

Knex.js (pronounced /kəˈnɛks/) is a "batteries included" SQL query builder for PostgreSQL, CockroachDB, MSSQL, MySQL, MariaDB, SQLite3, Better-SQLite3, Oracle, and Amazon Redshift designed to be flexible, portable, and fun to use.

It features both traditional node style callbacks as well as a promise interface for cleaner async flow control, a stream interface, full-featured query and schema builders, transaction support (with savepoints), connection pooling and standardized responses between different query clients and dialects.

JEST

Jest é um poderoso Framework de Testes em JavaScript com um foco na simplicidade. Funciona com projetos usando: Babel, TypeScript, Node, React, Angular, Vue e muito mais!

SWAGGER

Trata-se de uma aplicação open source que auxilia desenvolvedores nos processos de definir, criar, documentar e consumir APIs REST. Em suma, o Swagger visa padronizar este tipo de integração, descrevendo os recursos que uma API deve possuir, como endpoints, dados recebidos, dados retornados, códigos HTTP e métodos de autenticação, entre outros.

Autores

• @Player35Oficial

Licença

MIT