Skip to content

Latest commit

 

History

History
166 lines (119 loc) · 6.47 KB

README.md

File metadata and controls

166 lines (119 loc) · 6.47 KB
Raw
logo

Portal Brasil

GitHub contributors GitHub Repo stars

# Conteúdo

Introdução

O Portal Brasil é a distribuição Plone que contempla casos de uso do sistema de gestão de conteúdo Plone para organizações brasileiras.

Sucessor tecnológico do Portal Modelo e do Portal Padrão, a distribuição oferece aos seus usuários:

  • Tipos de conteúdo especializados
  • Conteúdos de Exemplo
  • Design padronizado, mas com possibilidade de pequenos ajustes

Funcionalidades Especializadas

  • Serviços
  • Pessoas
  • Agenda
  • Notícias
  • Cards

Pré-Requisitos

Software

  • Python 3.9, 3.10, 3.11
  • nvm
  • Node 16 (ver nota abaixo)
  • Yarn 3
  • Yeoman
  • Docker
  • GNU make

Nota:

  • Node.js 18 está em LTS desde 2022-10-25 e Node.js 16 está em modo manutenção. Entretanto, por conta de mudanças nas bibliotecas internas de SSL, algumas dependências do Volto foram descontinuadas e precisam ser atualizadas para continuar funcionando no Node.js 18, principalmente Webpack 4. Você pode usar o Node.js 18 mas precisará rodar com uma flag especial: NODE_OPTIONS=--openssl-legacy-provider. Volto's pull request suporta Node.js 18.
  • A instalação do Python está fora do escopo desta documentação. Entretanto, recomendamos usar o gerenciador de versões de Python pyenv que permite a instalação de múltiplas versões do Python no seu ambiente de desenvolvimento sem sobrescrever a versão do Python de seu sistema.

Hardware

Os requisitos abaixo são apenas uma estimativa mínima para um servidor Plone. Add-ons e soluções de cache podem requerer mais hardware.

  • Memória - Mínimo: 256 MB RAM e 512MB de SWAP para cada Plone site. Recomendável: 2 GB ou mais de RAM por Plone site.
  • Disco - Mínimo: 512 MB de espaço em disco. Recomendável: 40 GB ou mais de espaço em disco (avalie principalmente a quantidade de arquivos que o site poderá armazenar no futuro)

Sistema Operacional

  • Será necessário um Sistema operacional que rode todos os pré-requisitos de software. A maioria dos sistemas operacionais baseados em UNIX, incluindo a maioria das distribuições Linux, macOS ou Windows Subsystem for Linux (WSL) no Windows. Importante: Windows puro não é recomendado pois não suporta GNU make. Se você conseguir rodar Plone no Windows puro sem WSL, encorajamos você a documentar o processo e compartilhar com a comunidade.

Instalação

nvm

Os comandos a seguir usam o bash como shell. Adapte-os ao seu shell favorito. Veja também a documentação da instalação e atualização do nvm. Para o fish shell, veja nvm.fish

  1. Crie seu arquivo profile shell se ele não existe. Os comandos abaixo levam em conta o arquivo .bash_profile. Atente-se que em algumas distribuições como a Debian/Ubuntu este arquivo é o .bashrc. Adapte os comandos a seguir à sua distribuição.
touch ~/.bash_profile
  1. Faça download e rode script de instalação e atualização do nvm e insira-o no bash.
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.39.3/install.sh | bash
  1. Carregue seu arquivo profile. Alternativamente você pode fechar a seção e abrir uma nova.
source ~/.bash_profile
  1. Verifique se a versão do nvm é a que você instalou ou atualizou .
nvm --version

Node.js

  1. Instale ou atualize a versão do Node.js. Este comando também ativa a versão
nvm install 16
  1. Verifique se a versão suportada do Node.js está ativa
node -v

Yarn 3

  1. Instale o Yarn e atualize para a versão 3
npm install --global yarn
yarn set version berry
  1. Verifique se a versão 3 foi ativada
yarn -v

Yeoman

  1. Instale o Yeoman
npm install -g yo

Make

O make vem instalado na maioria das distribuições Linux. No macOS, você precisa primeiro instalar o Xcode então instale as ferramentas de linha de comando. No Windows, é recomendado instalar o Linux com WSL que inclui o make. Também é recomendado atualizar sua versão do make porque algumas distribuições, especialmente macOS, possuem versões desatualizadas. Use seu buscador preferido para encontrar como atualizar o make.

Docker

Instale o Docker Desktop para seu sistema operacional. Docker Desktop inclui todas as ferramentas Docker

Clonando o portal no git

git clone [email protected]:plonegovbr/plonegovbr.portal.git
cd portal-brasil
make install

Inicialização

Inicialização do Backend (http://localhost:8080/)

make start-backend

Inicialização do Frontend (http://localhost:3000/)

make start-frontend

Estrutura

Há duas bases de código no diretório: backend(API) e frontend.

  • backend: API (Backend) Instalação do Plone usando pip.
  • frontend: React (Volto)

Considerações

  • O repositório contém todo o código necessário para rodar o site.

Licença

Esse projeto é licenciado sob a licença GPLv2.

Teste o PortalBrasil

PortalBrasil.edu

Sigas as instruções para iniciar um ambiente com containers.