osamuca / onecode-api

Horizon Four - OneCode - TS - RESTFUL API com TypeScript e JWT Auth

Este é o repositório da base de uma API Rest com Hapi.js, Moongoose, JWTAuth e TypeScript, para utilizarmos como base para projetos futuros. **Dúvidas ?** [e-mail]

Status (CICD)

Branch	Status
master	?
develop	?

Pull Request

Todos os projetos precisam passar code review de pelo menos um membro do time H4.

Importante!

Para construção desse template de API foi utilizado o Git-Crypt, para verificar seu uso, acesse
GitCrypt Tutorial.
E para acessar esse ambiente entre em contato e solicite a chave 😄

Principais Dependencias

Esta é a lista com as principais dependencias que o seu projeto deve possuir.

Tipo	Nome	Link
Tests/Framework	Mocha	Mocha
Tests/Runner	?	-
Transpiler	Typescript	TS
CICD	?	SemaphoreCI
Server	Microsoft Azure (GCP)	Azure

Ferramentas

Para que você possa iniciar o desenvolvimento, verifique se você possui todas as ferramentas abaixo com o setup correto em sua máquina.

Ferramenta	Link
Docker	Link
GitFlow	Link
GitCrypt	Link
TSLint	Link
Airbnb Styleguide	Link
Prettier	Link
JSDoc	Link
JIRA	Link

Caso cliente externo que não possua Typescript no projeto

Ferramenta	Link
ESLint	Link

Dica

• Adicione as regras de Linters (eslint ou tslint) descritas no projeto, no formatOnSave do seu editor.
• Adicione adicione também o prettier e configure no formatOnSave para organizar e formatar o seu codigo.

IMPORTANTE

Nós utilizamos um pipe de CI/CD via SemaphoreCI.

O processo de test + build + deploy é realizado de maneira automática pelo CI escolhido. Todo commit no repositório do GitHub é deployado automáticamente, por isso muita atenção na branch master.

Isso aí. Tudo pronto pra construírmos um projeto DO CARALHO! #GOH4

Créditos

• Este repositório foi baseado na documentação do Drafteam