Clique aqui para baixar

FiliadosWeb
Sistema para gestão sindical
Documento Novos Analistas/Programadores
Versão 0.1
DOCUMENTO PARA NOVOS
ANALISTAS/PROGRAMADORES
ID documento: 001
Data: 03/07/2014
Versão : 0.1
Responsável pelo documento: Roque Junior Alves de Souza
ID Projeto: FWeb 1.0
HISTÓRICO DE REVISÕES
Data de
criação/
atualização
03/07/2014
Descrição da(s) Mudança(s)
Ocorrida(s)
Levantamentos dos arquivos
necessários para configurar a máquina
Autor
Roque Junior
Versão do
ID.
Documento Solicitação
de
Mudança
Alpha
-
SUMÁRIO
Conteúdo
DOCUMENTO PARA NOVOS PROGRAMADORES
2
SUMÁRIO........................................................................................................... 2
1
INTRODUÇÃO ............................................................................................ 3
1.1
Objetivo ................................................................................................. 3
2
1 INTRODUÇÃO
1.1 Objetivo
Este documento tem por objetivo instruir os novos analistas/desenvolvedores a
configurar seu equipamento antes do início efetivo das atividades.
1.2 Softwares Necessário
PHP 5.3.8+
MySQL 5.5.16+
Apache 2.2.21+
Recomenda-se a instalação de um ambiente de desenvolvimento como
Xampp, Wampp ou EasyPHP
TortoiseGit - https://code.google.com/p/tortoisegit/wiki/Download
Nos exemplos contidos abaixo serão usados como padrão os
caminhos contidos na instalação do XAMPP.
IDE de sua preferência
1.3 Configurando Git
Todos os arquivos do projeto FiliadosWEB estão armazenados no
servidor de controle de versão GitHub (www.github.com)
É necessário que o analista/programador possua uma conta no GitHub.
A gerência de configuração deverá acessar o GitHub e selecionar o
Dashboard da BisaWeb (Imagem 1) e adicionar a conta do
analista/desenvolvedor ao time correspondente. (Imagem 2)
(Imagem 1)
3
(Imagem 2)
O analista/desenvolvedor deverá na pasta htdocs criar um clone do
projeto seguindo os passos abaixo:
1. Clicar no botão direito dentro da pasta htdocs;
2. Selecionar a opção Git Clone...;
3. No campo URL, preencher com
[email protected]:BisaWeb/FiliadosWEB.git;
4. Clicar no botão OK
Uma cópia dos arquivos do projeto será colocada na pasta
C:\xampp\htdocs\FiliadosWEB
1.4 Configurando Servidor WEB
O primeiro passo para configurar o servidor web é manipular o arquivo
“hosts” do Windows. O arquivo HOSTS é um arquivo especial do sistema
operacional. Ele é capaz de forçar a resolução de certos nomes para
endereços IP específicos.
Vamos aos passos:
1. Abra o Bloco de Notas no modo “Administrador”
2. Vá no menu Arquivo -> Abrir
3. Insira o seguinte endereço: c:\Windows\System32\Drivers\etc\
4. Procure o arquivo hosts. Este arquivo não tem extensão
5. Colocar no final do arquivo, caso não haja, as linhas:
a. 127.0.0.1
localhost
b. 127.0.0.1
filiadosweb
É necessário também fazer algumas alterações no arquivo httpdvhosts.conf que fica em c:\xampp\apache\conf\extra\
1. Descomentar, caso esteja comentada, a linha que contém o texto
NameVirtualHost *:80
2. No final do arquivo colocar o seguinte código:
<VirtualHost *:80>
ServerAdmin [email protected]
4
DocumentRoot "c:/xampp/htdocs"
ServerName localhost
ServerAlias localhost
</VirtualHost>
<VirtualHost *:80>
ServerAdmin [email protected]
DocumentRoot "c:/xampp/htdocs/FiliadosWEB/src/public"
ServerName *.filiadosweb
ServerAlias *.filiadosweb
</VirtualHost>
3. O apache deve ser reiniciado
A partir deste momento a URL para acesso ao sistema FiliadosWEB
deverá ser http://bisa.filiadosweb/
1.5 Padrão de Codificação
O padrão de desenvolvimento adotado pela BisaWeb é o MVC, onde mais
detalhes sobre esta arquitetura podem ser vistos em
http://pt.wikipedia.org/wiki/Mvc
As principais regras de nomenclatura de classes, variáveis, indentação,
etc, podem ser vistos em:
C:\xampp\htdocs\FiliadosWEB\src\docs\auxiliar\padraoCodificacao\Padrã
o de Codificação PHP - BISAWEB.pdf
1.6 Zend Framework
Com o objetivo de padronizar a agilizar o desenvolvimento do
FiliadosWEB, foi escolhido o Zend Framework que é um framework para
aplicações Web de código aberto, orientado a objetos, implementado em
PHP.
Desenvolvido com a arquitetura MVC, as pastas do ZF se dispõem da
seguinte forma:
- Application – Pasta onde ficam os módulo do sistema, arquivos de
configuração do sistema
| - configs – Pasta onde ficam os arquivos de configuração e conexão
ao banco de dados do sistema, arquivo de funções e
arquivo base de permissões de acesso dos usuários do
sistema.
| - lang – Pasta do arquivo base de tradução do sistema
| - layouts – Pasta com os HTML que dão a visão externa de cada
pasta do sistema. Ex. Home, Dashboard, listagem
|- modules – Pasta dos módulos do sistema. Para cada módulo
existem mais 4 pastas:
1. controllers – Pasta com os controladores do módulo;
2. forms – Pasta com os arquivos base para montagem
dos formulários de cada módulo;
3. models – Pasta com os arquivos de classe básica e
as instruções SQL para manipulação dos dados do
banco;
5
4. views – Pasta com as página PHTML de exibição
dos conteúdos;
- library – Pasta com as bibliotecas do Zend o qualquer uma outra
biblioteca externa que seja incorporada ao projeto
- public – Pasta com os arquivos CSS, JS, imagens, etc.
Para cada sindicato no login é criada as seguintes pastas dentre de
public/arquivos: CNPJ_SINDICATO/
- carteirinha – Imagens das carteirinhas do sindicato
- configs – Arquivo de permissão exclusivo para o
sindicato
- documento_personalizado
- images
- lang – Arquivo de tradução exclusivo para o
sindicato
- siape
- usuários
Parte desta arquitetura pode ser vista em
C:\xampp\htdocs\\FiliadosWEB\src\docs\requisitos\DocumentoDeArquitetura.pd
f
1.7 Arquitetura Banco de Dados
O banco de dados utilizado para o desenvolvimento do FiliadosWEB é o
MySql e a estrutura do projeto pode ser vista em C:\xampp\htdocs\
FiliadosWEB\src\docs\banco\novo\banco_novo_com_procedures_e_funco
es.mwb utilizando a ferramenta MySql Workbench
1.8 Padrão de nomenclatura de base de dados
Para cada sindicato deverá ser criado um banco de dados específico
utilizando como padrão a nomenclatura filiadosweb_NOME_DO_SINDICATO.
Em caso de nome composto, estes devem ser separados por “_”
(underline)
1.9 Padrão de nomenclatura de URL para cliente
Para cada sindicato deverá ser criada uma URL específica, utilizando
como padrão a nomenclatura NOME-DO-SINDICATO.filiadosweb.com.br.
Em caso de nome composto, estes devem ser separados por “-“ (hífen)
O subdomínio da URL é quem irá determinar quais os dados o sistema
deverá acessar de um sindicato específico
1.10 Ambiente de homologação
Para homologação das requisições resolvidas do Mantis, o gerente de
configuração deverá no FTP criar dentro da pasta tags, uma pasta referente à
Sprint atual que as requisições dadas como fechadas deverão ser enviadas.
A primeira vez que os arquivos da Sprint forem ser enviados, todos os
arquivos das pastas C:\xampp\htdocs\FiliadosWEB\src\ deverão ser enviados
para o servidor, com exceção das pastas docs e tests.
6
Para as demais requisições, apenas os arquivos informados como
modificados deverão ser enviados para o servidor.
Na raiz do FTP o arquivo .htaccess deve ser alteradas nas linhas 8, 9, 10
e 13 para o nome da pasta da Sprint criada.
1.11 Ambiente de produção
Para as requisições dadas como fechadas no Mantis, o gerente de
configuração deverá no FTP, criar dentro da pasta tags, uma pasta com a
versão nova do sistema. Todos os arquivos deverão ser enviados para o
servidor, com exceção das pastas docs e tests.
7