Skip to content

Commit

Permalink
Repositório core commit incial
Browse files Browse the repository at this point in the history
  • Loading branch information
gitnnolabs committed Oct 18, 2022
0 parents commit f00772e
Show file tree
Hide file tree
Showing 326 changed files with 70,015 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.editorconfig
.gitattributes
.github
.gitignore
.gitlab-ci.yml
.idea
.pre-commit-config.yaml
.readthedocs.yml
.travis.yml
venv
27 changes: 27 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# http://editorconfig.org

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.{py,rst,ini}]
indent_style = space
indent_size = 4

[*.{html,css,scss,json,yml,xml}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab

[nginx.conf]
indent_style = space
indent_size = 2
14 changes: 14 additions & 0 deletions .envs/.local/.django
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# General
# ------------------------------------------------------------------------------
USE_DOCKER=yes
IPYTHONDIR=/app/.ipython
# Redis
# ------------------------------------------------------------------------------
REDIS_URL=redis://redis:6379/0

# Celery
# ------------------------------------------------------------------------------

# Flower
CELERY_FLOWER_USER=PhFRdLexbrsBvrrbSXxjcMMOcVOavCrZ
CELERY_FLOWER_PASSWORD=QgScyefPrYhHgO6onW61u0nazc5xdBuP4sM7jMRrBBFuA2RjsFhZLp7xbVYZbrwR
7 changes: 7 additions & 0 deletions .envs/.local/.postgres
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# PostgreSQL
# ------------------------------------------------------------------------------
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
POSTGRES_DB=core
POSTGRES_USER=GVRFlLmcCNfGLhsFvSnCioYOPJPYpyfj
POSTGRES_PASSWORD=BQ4hSUL4rdj5WZLdR8ilDLRQMvCtzo0caMaXDO0olGsmycQjlcZlTVK9DepZR8kk
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/nova-funcionalidade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
name: Nova funcionalidade
about: Contribua com novas idéias e necessidades
title: ''
labels: enhancement
assignees: ''

---

### Descrição da nova funcionalidade
Eu, como **[tipo de cargo/ usuário / papel em sistema]**, gostaria que **[descrição breve da funcionalidade]**, então **[consequência ou o porque da requisição da atividade]**.

### Critérios de aceitação

Lista de critérios a serem observados pela equipe de engenharia durante a elaboração e construção da tarefa. Seja claro(a), descreva os pontos que são importantes para você:
- Ex 1: Fale sobre qual deve ser o comportamento da funcionalidade;
- Ex 2: Fale sobre quais validações um formulário deve conter;
- Ex 3: Fale sobre os tipos de impressão uma página deve suportar;
- Ex 4: Fale sobre os tipos de usuários podem realizar a ação requisitada;
- Critério 5;
- Critério 6

### Anexos
Este tópico é opcional mas pode ser utilizado para incluir objetos a serem analisados ou demonstrações que podem ser utilizados de exemplo.

### Referências
Este tópico é opcional mas pode ser utilizado para enumerar items de referências como links ou bibliografia.


----

# Exemplos

### 1) Descrição do requisito

Como Usuário Administrador do OPAC, gostaria que o botão de publicação de periódicos possuisse **DESTAQUE**, assim poderia ter um indicativo visual de cuidado antes de clicar.

### Critérios de aceitação

Para que esta tarefa seja considerada concluída deve conter os seguintes pontos:
- O botão de publicação deve possuir um tom vermelho que se destaque dos outros elementos de tela;
- O botão deve conter o modo daltônico para que os membros daltônicos do time de publicação possam identifica-lo com facilidade;
- O botão deve ter conter um indicativo de "descrição de ação" ao posicionar o mouse e aguardar alguns segundos.

### Anexos
N/A

### Referências
N/A

---
### 2) Descrição do requisito
Como Usuário visitante do OPAC, gostaria que a página de artigos fosse adaptativa para celulares, assim poderia utilizar meu dispositivo móvel para navegar com mais facilidade.

### Critérios de aceitação

Os seguintes pontos devem ser contemplados:
- Os botões de navegação nesta tela devem ser de fácil acesso e possuir fácil toque;
- Os textos nesta tela devem possuir tamanho adequado para leitura seguindo os padrões da W3C;
- Deve-se agrupar em blocos as seções de página para facilitar a navegabilidade;

### Anexos
N/A

### Referências
N/A

---
### 3) Descrição do requisito
Como administrador do processo de qualidade, gostaria de ter um pré visualizador de HTML, assim poderia validar a marcação dos XMLs antes de envia-lo para publicação.


### Critérios de aceitação

Os seguintes pontos devem ser contemplados:
- O visualizador de HTML deve ser auto contido e não depender de internet;
- O visualizador de HTML deve funcionar a partir do SPS 1.8;
- O visualizador de HTML deve exibir o conteúdo da mesma forma que o site oficial;
- O visualizador de HTML deve projetar as tabelas de forma correta;

### Anexos
N/A

### Referências
N/A
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/reportar-problema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Reportar problema
about: Reporte um erro ou problema e nos ajude a melhorar nossos produtos
title: ''
labels: bug
assignees: ''

---

### Descrição do problema
Descreva de forma clara e objetiva o problema relatado.

### Passos para reproduzir o problema
1. Acesse a página ...
2. Clique no link ...
3. Role a página até ...
4. Observe o erro apresentado

### Comportamento esperado
Descreva com clareza qual seria o comportamento **esperado** (correto) ao reproduzir os passos acima.

### Screenshots ou vídeos
Para dar mais detalhes e contexto sobre o erro, considere anexar fotos ou vídeos do problema.

### Anexos
Está seção é opcional, utilize para referenciar arquivos que servem de insumo para reproduzir o erro, ex:
- XML utilizado
- HTML produzido
- PDF criado

### Ambiente utilizado

Quando aplicável, forneça detalhes sobre o ambiente utilizado, ex:

- Navegador Mozilla Firefox versão 30
- Windows XP
- PC programs versão 1.0
- Aparelho celular iPhone 7, iOS 7
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/tarefa-de-desenvolvimento.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Tarefa de desenvolvimento
about: Tarefas definidas pelo próprio time de desenvolvimento
title: ''
labels: task
assignees: ''

---

### Descrição da tarefa
Descreva de forma clara e objetiva a tarefa em questão

### Subtarefas

- [ ] Descrição da primeira subtarefa
- [ ] Descrição da segunda subtarefa


## Considerações e notas

* A implementação destas mudanças implica em aumentar o consumo de disco..
79 changes: 79 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Config for Dependabot updates. See Documentation here:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates

version: 2
updates:
# Update GitHub actions in workflows
- package-ecosystem: "github-actions"
directory: "/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Docker
# We need to specify each Dockerfile in a separate entry because Dependabot doesn't
# support wildcards or recursively checking subdirectories. Check this issue for updates:
# https://github.com/dependabot/dependabot-core/issues/2178
- package-ecosystem: "docker"
# Look for a `Dockerfile` in the `compose/local/django` directory
directory: "compose/local/django/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Docker
- package-ecosystem: "docker"
# Look for a `Dockerfile` in the `compose/local/docs` directory
directory: "compose/local/docs/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Docker
- package-ecosystem: "docker"
# Look for a `Dockerfile` in the `compose/local/node` directory
directory: "compose/local/node/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Docker
- package-ecosystem: "docker"
# Look for a `Dockerfile` in the `compose/production/aws` directory
directory: "compose/production/aws/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Docker
- package-ecosystem: "docker"
# Look for a `Dockerfile` in the `compose/production/django` directory
directory: "compose/production/django/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Docker
- package-ecosystem: "docker"
# Look for a `Dockerfile` in the `compose/production/postgres` directory
directory: "compose/production/postgres/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Docker
- package-ecosystem: "docker"
# Look for a `Dockerfile` in the `compose/production/traefik` directory
directory: "compose/production/traefik/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"

# Enable version updates for Python/Pip - Production
- package-ecosystem: "pip"
# Look for a `requirements.txt` in the `root` directory
# also 'setup.cfg', 'runtime.txt' and 'requirements/*.txt'
directory: "/"
# Check for updates to GitHub Actions every weekday
schedule:
interval: "daily"
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#### O que esse PR faz?
Fale sobre o propósito do pull request como por exemplo: quais problemas ele soluciona ou quais features ele adiciona.

#### Onde a revisão poderia começar?
Indique o caminho do arquivo e o arquivo onde o revisor deve iniciar a leitura do código.

#### Como este poderia ser testado manualmente?
Estabeleça os passos necessários para que a funcionalidade seja testada manualmente pelo revisor.

#### Algum cenário de contexto que queira dar?
Indique um contexto onde as modificações se fazem necessárias ou passe informações que contextualizam
o revisor a fim de facilitar o entendimento da funcionalidade.

### Screenshots
Quando aplicável e se fizer possível adicione screenshots que remetem a situação gráfica do problema que o pull request resolve.

#### Quais são tickets relevantes?
Indique uma issue ao qual o pull request faz relacionamento.

### Referências
Indique as referências utilizadas para a elaboração do pull request.

60 changes: 60 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: CI

# Enable Buildkit and let compose use it to speed up image building
env:
DOCKER_BUILDKIT: 1
COMPOSE_DOCKER_CLI_BUILD: 1

on:
pull_request:
branches: [ "master", "main" ]
paths-ignore: [ "docs/**" ]

push:
branches: [ "master", "main" ]
paths-ignore: [ "docs/**" ]

concurrency:
group: ${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
linter:
runs-on: ubuntu-latest
steps:

- name: Checkout Code Repository
uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.9"
cache: pip
cache-dependency-path: |
requirements/base.txt
requirements/local.txt
- name: Run pre-commit
uses: pre-commit/[email protected]

# With no caching at all the entire ci process takes 4m 30s to complete!
pytest:
runs-on: ubuntu-latest

steps:

- name: Checkout Code Repository
uses: actions/checkout@v2

- name: Build the Stack
run: docker-compose -f local.yml build

- name: Run DB Migrations
run: docker-compose -f local.yml run --rm django python manage.py migrate

- name: Run Django Tests
run: docker-compose -f local.yml run django pytest

- name: Tear down the Stack
run: docker-compose -f local.yml down
Loading

0 comments on commit f00772e

Please sign in to comment.