From 1736e9d56d3c28360e337f9f94e21400da2eb1a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rog=C3=A9rio=20Fr=C3=A1?= Date: Thu, 1 Dec 2016 15:46:48 -0200 Subject: [PATCH] Update README.rst --- README.rst | 197 +---------------------------------------------------- 1 file changed, 1 insertion(+), 196 deletions(-) diff --git a/README.rst b/README.rst index e10b3b254..5ffdda86f 100644 --- a/README.rst +++ b/README.rst @@ -17,206 +17,11 @@ atual do sistema (2.5), visite a página do `projeto na Interlegis wiki `_; - - * edite e incremente outros, ou ainda, crie outros readme's dentro do projeto para outros SO's e adicione o link aqui. - -Instalar as seguintes dependências do sistema:: ----------------------------------------------------------------------------------------- - -* :: - - sudo apt-get install git python3-dev libpq-dev graphviz-dev graphviz \ - pkg-config postgresql postgresql-contrib pgadmin3 python-psycopg2 \ - software-properties-common build-essential libxml2-dev libjpeg-dev \ - libmysqlclient-dev libssl-dev libffi-dev libxslt1-dev python3-setuptools \ - python3-pip curl - - sudo -i - curl -sL https://deb.nodesource.com/setup_5.x | bash - - exit - sudo apt-get install nodejs - - sudo npm install npm -g - sudo npm install -g bower - -Instalar o virtualenv usando python 3 para o projeto. ------------------------------------------------------ - -* Para usar `virtualenvwrapper `_, instale com:: - - sudo pip install virtualenvwrapper - - mkdir ~/Envs - -* Edite o arquivo ``.bashrc`` e adicione ao seu final as configurações abaixo para o virtualenvwrapper:: - - export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3 - export WORKON_HOME=$HOME/.virtualenvs - export PROJECT_HOME=$HOME/Envs - source /usr/local/bin/virtualenvwrapper.sh - -* Saia do terminal e entre novamente para que as configurações do virtualenvwrapper sejam carregadas. - -Clonar o projeto do github, ou fazer um fork e depois clonar ------------------------------------------------------------- - -* Para apenas clonar do repositório do Interlegis:: - - cd ~/Envs - git clone git://github.com/interlegis/sapl - -* Para fazer um fork e depois clonar, siga as instruções em https://help.github.com/articles/fork-a-repo que basicamente são: - - * Criar uma conta no github - é gratuíto. - * Acessar https://github.com/interlegis/sapl e clicar em **Fork**. - - Será criado um domínio pelo qual será possível **clonar, corrigir, customizar, melhorar, contribuir, etc**:: - - cd ~/Envs - git clone git://github.com/[SEU NOME]/sapl - -* As configurações e instruções de uso para o git estão espalhadas pela internet e possui muito coisa bacana. As tarefas básicas de git e suas interações com github são tranquilas de se aprender. - - -Criar o ambiente virtual de desenvolvimento para o SAPL -------------------------------------------------------- -* :: - - mkvirtualenv sapl -a $HOME/Envs/sapl -p /usr/bin/python3 - -Instalação e configuração das dependências do projeto ------------------------------------------------------ - -* **Acesse o terminal e entre no virtualenv**:: - - workon sapl - -* **Instalar dependências python**:: - - pip install -r requirements/dev-requirements.txt - -* **Configurar Postgresql**: - - * Acessar Postrgresql para criar o banco ``sapl`` com a role ``sapl``:: - - sudo su - postgres - psql - - CREATE ROLE sapl LOGIN - ENCRYPTED PASSWORD 'sapl' - NOSUPERUSER INHERIT CREATEDB NOCREATEROLE NOREPLICATION; - - ALTER ROLE sapl VALID UNTIL 'infinity'; - - CREATE DATABASE sapl - WITH OWNER = sapl - ENCODING = 'UTF8' - TABLESPACE = pg_default - LC_COLLATE = 'pt_BR.UTF-8' - LC_CTYPE = 'pt_BR.UTF-8' - CONNECTION LIMIT = -1; - - \q - exit - - * Se você possui uma cópia da base de dados do SAPL, essa é a hora para restaurá-la. - * Obs: no ambiente de desenvolvimento, a role deve ter permissão para criar outro banco. Isso é usado pelos testes automatizados. - * (caso você já possua uma instalação do postrgresql anterior ao processo de instalação do ambiente de desenvolvimento do SAPL em sua máquina e sábia como fazer, esteja livre para proceder como desejar, porém, ao configurar o arquivo ``.env`` no próximo passo, as mesmas definições deverão ser usadas) - -* **Configurar arquivo .env**: - - * Criação da `SECRET_KEY `_: - - É necessário criar um projeto fake para extrair uma chave SECRET_KEY:: - - mkdir ~/Envs/temp - cd ~/Envs/temp - - django-admin startproject sapl_temp - - grep SECRET_KEY sapl_temp/sapl_temp/settings.py - - Copie a linha que aparecerá, volte para a pasta do projeto SAPL e apague sua pasta temporária:: - - cd ~/Envs/sapl - rm -R ~/Envs/temp - - * Criar o arquivo ``.env`` dentro da pasta ~/Envs/sapl/sapl/.env:: - - DATABASE_URL = postgresql://USER:PASSWORD@HOST:PORT/NAME - SECRET_KEY = Gere alguma chave e coloque aqui - DEBUG = [True/False] - EMAIL_USE_TLS = [True/False] - EMAIL_PORT = [Insira este parâmetro] - EMAIL_HOST = [Insira este parâmetro] - EMAIL_HOST_USER = [Insira este parâmetro] - EMAIL_HOST_PASSWORD = [Insira este parâmetro] - - * Uma configuração mínima para atender os procedimentos acima seria:: - - DATABASE_URL = postgresql://sapl:sapl@localhost:5432/sapl - SECRET_KEY = 'Substitua esta linha pela copiada acima' - DEBUG = True - EMAIL_USE_TLS = True - EMAIL_PORT = 587 - EMAIL_HOST = - EMAIL_HOST_USER = - EMAIL_HOST_PASSWORD = - - - -* Instalar as dependências do ``bower``:: - - ./manage.py bower install - -* Atualizar e/ou criar as tabelas da base de dados para refletir o modelo da versão clonada:: - - ./manage.py migrate - -* Atualizar arquivos estáticos:: - - ./manage.py collectstatic --noinput - -* Subir o servidor do django:: - - ./manage.py runserver - -* Acesse o SAPL em:: - - http://localhost:8000/ - -Instruções para criação do super usuário e de usuários de testes -=========================================================================== - -* Criar super usuário do django-contrib-admin (Será solicitado alguns dados para criação):: - - ./manage.py createsuperuser - -* `Os perfis semânticos do SAPL `_ são fixos e atualizados a cada execução do comando:: - - ./manage.py migrate - -* Os perfis fixos não aceitam customização via admin, porém outros grupos podem ser criados. O SAPL não interferirá no conjunto de permissões definidas em grupos customizados e se comportará diante de usuários segundo seus grupos e suas permissões. - -* Os usuários de testes de perfil são criados apenas se o SAPL estiver rodando em modo DEBUG=True. Todos com senha "interlegis", serão:: - - operador_administrativo - operador_protocoloadm - operador_comissoes - operador_materia - operador_norma - operador_sessao - operador_painel - operador_geral + `Instalação do Ambiente de Desenvolvimento `_ Instruções para Importação da base mysql 2.5 ============================================ - `Importação da Base do SAPL 2.5 para SAPL 3.1 `_