Prova da Ordem

Implementação da identidade visual do CURSO PROVA DA ORDEM

Índice

• Instalação
• Versionamento
• Módulos
• Desenvolvimento
• Publicação
  • Chaves de Acesso
• Comandos

Instalação

Para realizar a instalação do projeto você deverá seguir os passos abaixo:

• Clonar o repositório: git clone https://bitbucket.org/primesoft/pdo.site.theme.git
• Instalar as dependencias npm: npm install
• Executar um ou mais comandos disponíveis: npm run ...

Versionamento

Para manter a transparência em nossas publicações e na tentativa de manter compatibilidade entre versões, este projeto é mantido sob as diretrizes da Semantic Versioning. As vezes fazemos cagada cachorrinho, mas tentamos seguir as diretrizes sempre que possível.

Módulos

• Gateway de Pagamentos
  • id: checkout
  • publish: --module=checkout
• Plataforma de Questões Comentadas
  • id: sisprovas
  • publish: --module=sisprovas
• Site
  • id: site
  • publish: --module=site
• Sistema de autenticação
  • id: sso
  • publish: --module=sso

Desenvolvimento

Para desenvolvimento é necessário seguir os passos abaixo:

• Configurar o browser-sync...(TODO)
• Executar o seguinte comando: gulp dev

Publicação

Para realizar a publicação é necessário seguir os passos abaixo:

• Configurar as chaves de acesso a Amazon S3.
• Executar o seguinte comando: gulp deploy --mode=$mode --module=$module --version=$version
  • $mode => development ou production
  • $publishMode => chave de acesso
  • $module => módulos
  • $version => ex: v1.0.0

Chaves de Acesso Amazon S3

As chaves de acesso devem ser configuradas no arquivo ./publishers.json.

{
    "development": {
        "region": "",
        "params": {
            "Bucket": ""
        },
        "accessKeyId": "",
        "secretAccessKey": ""
    }
    "production": {
        "region": "",
        "params": {
            "Bucket": ""
        },
        "accessKeyId": "",
        "secretAccessKey": ""
    }
}

Comandos Disponíveis

• Build dos módulos
• Build dos módulos para desenvolvimento
• Publicação de módulo
• Limpar pasta de build

Build dos módulos

gulp build

| Parâmetro | Valores | Padrão | Descrição | | --- | --- | --- | -- | | mode | development/production | development | Define se assets devem ser otimizados/minificados.

Build dos módulos para desenvolvimento com hot-deploy, inject-css e auto-reload

gulp dev --mode=$mode --proxy=$proxy

| Parâmetro | Valores | Padrão | Descrição | | --- | --- | --- | --- | | mode | development/production | development | Define se assets devem ser otimizados/minificados. | proxy | proxy option | config.proxy | Configuração de proxy do plugin browsersync

Publicação de módulo individualmente

gulp deploy --mode=$ --module=$ --version=$

| Parâmetro | Valores | Padrão | Descrição | | --- | --- | --- | --- | | mode | development/production | production | Define se assets devem ser otimizados/minificados. | publishMode | chave de acesso | obrigatório | Define qual chave de acesso deve ser utilizada. | module | módulos | obrigatório | Módulo a ser publicado | version | ex:v1.0.0 | obrigatório | Versão ser publicada

Limpar pasta de build

gulp clean