/2020.1_G3_RecipeBuk_Backend

Primary LanguageJavaScript

Logo RecipeBuk

Build Status

Azure DevOps coverage

RecipeBük

Toda a nossa documentação está disponível para visualização em: http://www.recipebukdocs.tk/

Se você quiser, poderá conferir também nosso repositório de Frontend.

Número da Lista: 03
Conteúdo da Disciplina: FGA0208 - T01

Alunos

Matrícula Aluno
17/0031438 Dâmaso Júnio Pereira Brasileo
17/0102343 Eduardo Vieira Lima
16/0130883 Larissa Siqueira Sales
15/0135939 Letícia Karla Soares Rodrigues de Araújo
17/0109208 Luís Henrique Pereira Taira
17/0114040 Samuel de Souza Buters Pereira

Sobre

O RecipeBük é uma aplicação de armazenamento, busca e compartilhamento de receitas culinárias. A ideia é que seja possível a todos cadastrar as suas próprias receitas e mantê-las a salvo.

Instalação

Para executar a aplicação, é necessário ter instalado:

Docker

Para instalar o Docker, basta seguir as intruções disponíveis aqui.

Make

Para instalar o Make, basta executar o seguinte comando:

sudo apt-get install build-essential

Uso

Para efetuar o build do container Docker de desenvolvimento e rodá-lo, basta executar o seguinte comando:

make up-build

Para apenas rodar, basta executar o seguinte comando:

make up

Políticas de Contribuição

Commits

  • Os Commits devem ser escritos em inglês;

  • Devem ser curtos e objetivos;

  • Devem iniciar com verbo no passado;

  • Devem ser compostos por:

    [#numero-da-issue] Mensagem

Exemplo:

    [#20] Implemented new text box

Branches

As branchs são baseadas no modelo de GitFlow e são dividas em:

  • master: aplicação em sua versão estável;
  • dev: versão de desenvolvimento que servirá como base para as demais branches.

Para a criação de uma nova branch, deve-se criá-la a partir da dev e manter o seguinte padrão:

  • Os nomes das branches deverão ser compostos por:
        numero-da-issue-nome-da-issue

Exemplo:

        20-criacao-da-tela-de-cadastro-de-receitas

Pull Requests

  • Os PRs devem ser criados a partir do template do repositório;

  • Os PRs devem englobar as modificações necessárias para apenas uma issue;

  • O merge das branches criadas a partir da dev nunca deverá ser feito na master;

  • Após o merge, se a branch não tiver mais uso, ela deverá ser apagada