search

FabSoftUnicentro / e-DefPR

Software para Controle de Processos - Defensoria Pública do Paraná
MIT License
5 stars 1 forks source link

readme

e-DefPR

Software para Controle de Processos - Defensoria Pública do Paraná

Sumário

  1. Guia Geral
  2. Workflow
  3. Instalação da Aplicação
  4. Execução e Gerenciamento de Tarefas
  5. Estrutura

  6. Sobre

    Guia Geral

Esclarecimentos gerais relacionados a documentação:

Workflow

Execução e Gerenciamento de Tarefas

Processo automatizado:

1. Executar: edef-issue-start xxx, onde xxx se refere ao número da tarefa no Waffle.
2. Efetuar as modificações no código-fonte.
3. Executar: git add [ARQUIVO INDIVIDUAL ou LISTA DE ARQUIVOS].
    - IMPORTANTE: Não recomendo o uso de: 'git add .'
4. Executar: git commit -m "MENSAGEM EXPLICATIVA" após cada 'git add [ARQUIVO INDIVIDUAL ou LISTA DE ARQUIVOS]' do passo 6.
    - IMPORTANTE: Na "MENSAGEM EXPLICATIVA" explicar de forma resumida o que foi modificado nos arquivos que que foram adicionados no 'git add'.
5. Executar: git push origin issue#xxx, onde xxx se refere ao número da tarefa no Waffle.
6. Executar: edef-issue-request-review auto ou edef-issue-request-review manual (auto cria a PR automaticamente e o manual redirecionada para a página do GitHub)
7. Comunicar no channel o link da PR pedindo review de código.
8. Esperar pelo menos 1 ou 2 Approves e após isso realizar o merge no site do GitHub.
    - IMPORTANTE: Caso as modificações foram complexas e/ou muito imporantes requisitar mais Approves do que somente 2.
9. Ir na página da Pull Request no GitHub e realizar o merge.

Processo manual:

1. Comunicar no channel apropriado (backend, frontend, random) o início da tarefa
2. Executar: git pull origin master
3. Executar: git checkout -b issue#xxx, onde XXX é o numero da issue no Waffle.
4. Executar: git push --set-upstream origin issue#xxx, onde XXX é o numero da issue no Waffle.
5. Mover a tarefa para a coluna In-progress no Waffle caso não for movida automaticamente.
6. Efetuar as modificações do código fonte.
7. Executar: git add [ARQUIVO INDIVIDUAL ou LISTA DE ARQUIVOS].
    - IMPORTANTE: Não recomendo o uso de: 'git add .'
8. Executar: git commit -m "MENSAGEM EXPLICATIVA" após cada 'git add [ARQUIVO INDIVIDUAL ou LISTA DE ARQUIVOS]' do passo 6.
    - IMPORTANTE: Na "MENSAGEM EXPLICATIVA" explicar de forma resumida o que foi modificado nos arquivos que que foram adicionados no 'git add'.
9. Executar: git push origin issue#xxx, onde xxx se refere ao número da tarefa no Waffle..
10. Ir na página do repositório no GitHub na parte de branches e criar a PR (Pull Request).
    - IMPORTANTE: Na descrição da PR colocar: fixed #XXX, onde XXX é o numero da issue no Waffle.
12. Comunicar no channel o link da PR pedindo review de código.
13. Esperar pelo menos 1 ou 2 Approves e após isso realizar o merge no site do GitHub.
    - IMPORTANTE: Caso as modificações foram complexas e/ou muito imporantes requisitar mais Approves do que somente 2.
14. Ir na página da Pull Request no GitHub e realizar o merge.
15. Executar: git checkout master
16. Executar: git pull origin master
17. Executar: git branch -d issue#xxx.

Inicialização

Frontend:

  Dentro da pasta Frontend
  1. yarn install
  2. yarn start

Backend:

  Dentro da pasta Backend
  1. composer install
  2. php artisan migrate:refresh
  3. php artisan migrate
  4. php artisan passport:install
  5. php artisan db:seed
  6. php artisan serve

Estrutura

Sobre