Integrated Government Resources Planning IGRP Open Source. Como importar e contribuir - GitHub. Núcleo Operacional da Sociedade de Informação

Transcrição

1 Núcleo Operacional da Sociedade de Informação Integrated Government Resources Planning IGRP Open Source Como importar e contribuir - GitHub

2 Índice Listas de Figuras... 2 Introdução... 3 Instalação Do Eclipse... 4 Instalacao do TomCat Versao Fazendo Fork (Cópia) do projecto para a sua conta no GitHub... 5 Configurar IGRP-Framework no Eclipse IDE... 9 Como contribuir com um trecho de código - GitHub IGRP FRAMEWORK OPEN SOURCE 1

3 Listas de Figuras Figura 1 - Fazendo Download do Eclipse... 4 Figura 2 - Fazendo Download do Eclipse... 4 Figura 3 - Download Do TomCat Figura 4 - Página Inicial do 6 Figura 5 - Página Inicial NosiCode... 6 Figura 6 - Pesquisa IGRP-Framework... 7 Figura 7 - Processo Fork... 7 Figura 8 - Processo do Fork. Cont... 8 Figura 9 - Mostrar cópia do IGRP-Framework... 9 Figura 10 - Fazer Clone do IGRP-Framework Figura 11 - Importar Projeto Figura 12 - Selecionar import para o projeto Figura 13 - Configurar repositório no eclipse Figura 14 - Colocar caminho do seu projeto Figura 15 - Propriedade do Projeto Figura 16 - Propriedade do Projeto - Copiar caminho Figura 17 - Ficheiro LinkedResource.xml Figura 18 - Colocar caminho do projeto no LinkedResource.xml Figura 19 - Instalação do TomCat Figura 20 - Instalação do TomCat, Escolhendo as opcções Figura 21 - Instalação do TomCat, Finish Figura 22 - Ficheiro que se pretende mudar Figura 23 - Ficheiro Modificado Figura 24 - Configuração Git Staging Figura 25 - Configuração Git Staging. Continuação Figura 26 - Aba Git Staging Figura 27 - Commit and Push Figura 28 - Status do Push Figura 29 - Mensagem de sucesso de Push Figura 30 - New Pull Request Figura 31 - New Pull Request. Cont Figura 32 - Start Server Figura 33 - Rodar o IGRP Figura 34 - Rodando o IGRP IGRP FRAMEWORK OPEN SOURCE 2

4 Introdução O IGRP (Integrated Government Resource Planning) tem a ambição de se posicionar como um produto inovador que disponibiliza um pacote integrado de soluções para a Governação. Vocacionado para uma abordagem Holística da Administração Como consequência dessa visão holística, assenta toda a sua lógica no princípio de "Write Once, Read Many", ou seja as informações não são duplicadas dentro da Administração e podem ser acedidas entre departamentos. Este tutorial mostra como contribuir para o projecto IGRP-Framework utilizando o GitHub e o Eclipse Java for Developers Version Neon.3. Foi usado este IDE (integrated development environment) por facilitar a integração do Git no projecto. GitHub - é uma plataforma de hospedagem de código para controle de versão e colaboração, permitindo que todos trabalhem juntos em projectos em qualquer lugar. Repositório é utilizado para organizar projecto, que podem conter pastas com ficheiros, imagens, vídeos, etc. IGRP FRAMEWORK OPEN SOURCE 3

5 Instalação Do Eclipse Em primeiro lugar, é preciso ter o Eclipse instalado na maquina, para tal é preciso fazer o download do mesmo, atraves do link Acessando o link, pode-se fazer o download para diferentes plataformas, depois de escolher a plataforma é só fazer o download. (demostrada na figura 1 e 2). Figura 1 - Fazendo Download do Eclipse Figura 2 - Fazendo Download do Eclipse IGRP FRAMEWORK OPEN SOURCE 4

6 Instalacao do TomCat Versao 9.0 Acessando o link ( pode-se baixar o TomCat clicando nas opções de download de acordo com as plataformas. (Demostrada na figura 3) Figura 3 - Download Do TomCat 9.0 Depois de ter baixado, descompactar a pasta do TomCat e colocar no local da sua preferência. Fazendo Fork (Cópia) do projecto para a sua conta no GitHub Para contribuir no projecto IGRP-Framework, precisamos primeiramente ter uma conta no GitHub e claro estar devidamente autenticado no sistema. Em seguida efetuar o Fork (cópia) para o repositório da sua conta. Para efectuar Fork do IGRP-Framework siga os seguintes passos: 1. Pesquisar o projecto IGRP-Framework no campo de pesquisa, ilustrada na figura 4 ou ainda acessar o site e clicar no botão contribua ilustrada na figura 5 onde é direccionado para o repositório do IGRP. IGRP FRAMEWORK OPEN SOURCE 5

7 Campo de Pesquisa Figura 4 - Página Inicial do Figura 5 - Página Inicial NosiCode IGRP FRAMEWORK OPEN SOURCE 6

8 2. Após a apresentação do resultado da pesquisa, clique sobre o link do projecto Figura 6 - Pesquisa IGRP-Framework 3. Depois de clicar sobre o link do projecto, será direccionada para uma nova página, onde o utilizador pode fazer Fork para seu repositório. Para este efeito, clique no botão Fork, ilustrada na figura 7. Botão fork Figura 7 - Processo Fork IGRP FRAMEWORK OPEN SOURCE 7

9 4. Será apresentada uma página idêntico ao da figura 7. Figura 8 - Processo do Fork. Cont IGRP FRAMEWORK OPEN SOURCE 8

10 5. Quando o Forking do IGRP-Framework terminar, pode voltar para a página inicial do GitHub e verificar que o projeto foi copiado para o seu repositório. Figura 9 - Mostrar cópia do IGRP-Framework Cópia do IGRP-Framework Configurar IGRP-Framework no Eclipse IDE 1. Clique no botão Clone or download 2. Copie o link do repositório do IGRP-Framework IGRP FRAMEWORK OPEN SOURCE 9

11 Link do repositório IGRP-Framework Botão Clone or download 3. Abra o Eclipse. 4. Clique no menu file. 5. Escolhe a opção import. Figura 10 - Fazer Clone do IGRP-Framework Figura 11 - Importar Projeto IGRP FRAMEWORK OPEN SOURCE 10

12 6. Depois de clicar no botão import, uma nova janela será apresenta. Escolhe a opção Git e selecione a opção Projects from Git, ilustrada na figura 12. Opção para importar projeto git Figura 12 - Selecionar import para o projeto 7. Clique em Next. 8. Selecione a opção Clone URI e clique em Next novamente. 9. Na janela seguinte, cole o link do repositório que foi copiado para o campo URI, ilustrada na figura 13. IGRP FRAMEWORK OPEN SOURCE 11

13 Campo URI Coloque o link do projeto aqui Figura 13 - Configurar repositório no eclipse Coloque o nome da conta e palavra passe do GitHub para ter acesso ao repositório 10. Clique em Next novamente 11. Na janela seguinte clique em Next novamente. 12. Coloque o caminho para o armazenar o projeto localmente. IGRP FRAMEWORK OPEN SOURCE 12

14 Figura 14 - Colocar caminho do seu projeto 13. Em seguida clique em Next 14. Por fim clique em Finish Depois de importar o projeto para o eclipse, deve ser configurado o caminho do projeto para que quando as páginas geradas no gerador sejam guardadas tanto dentro do projeto no eclipse, como também dentro do Tomcat Server. IGRP FRAMEWORK OPEN SOURCE 13

15 Para o efeito segue-se os seguintes passos: 1. Clique botão direito sobre o projeto. 2. Selecionar propriedade assim como ilustrada na figura 15. Figura 15 - Propriedade do Projeto IGRP FRAMEWORK OPEN SOURCE 14

16 3. Quando a propriedade do projeto abrir, copie o caminho do projeto, ilustrada na figura 16. Caminho do projeto Figura 16 - Propriedade do Projeto - Copiar caminho IGRP FRAMEWORK OPEN SOURCE 15

17 Ir para o ficheiro LinkedResource.xml, localizado no caminho WebContent/WEB- INF/config/app, ilustrada na figura 17. Figura 17 - Ficheiro LinkedResource.xml 4. Coloque o caminho copiado dentro da tag ProjectLoc, ilustrada na 18. Figura 18 - Colocar caminho do projeto no LinkedResource.xml 5. Agora passando para a parte da configuração do TomCat, clique esquerdo na aba do Server, clique esquerdo no link No server are (Ilustrada na figura 19), vai aparecer uma janela onde temos as opcções da versão do tomcat do servidor que queremos criar, adicionar o igrp e depois finish (Ilustrada na figura 20 e 21). Figura 19 - Instalação do TomCat IGRP FRAMEWORK OPEN SOURCE 16

18 Figura 20 - Instalação do TomCat, Escolhendo as opcções Figura 21 - Instalação do TomCat, Finish IGRP FRAMEWORK OPEN SOURCE 17

19 Como contribuir com um trecho de código - GitHub Através da tecnologia Git (ferramenta para controle de versão), pode-se fazer uma nova contribuição a qualquer momento. A figura 22 mostra o ambiente do Eclipse com o respectivo ficheiro que se pretende modificar. Figura 22 - Ficheiro que se pretende mudar A figura 23 mostra o mesmo ficheiro já com a inserção do código que queremos contribuir, lembrando que a contribuição pode ser feita em qualquer ficheiro mas a aprovação depende inteiramente do administrador do repositório no GitHub. IGRP FRAMEWORK OPEN SOURCE 18

20 Figura 23 - Ficheiro Modificado O eclipse tem uma aba que mostra os devidos ficheiros modificados chamado Git Staging. Por default essa aba não aparece, para tal temos de fazer a seguinte configuração: 1. Clique esquerdo no Window, depois show view em seguida other. (Ilustrada na figura 24). Figura 24 - Configuração Git Staging IGRP FRAMEWORK OPEN SOURCE 19

21 2. Vai a parecer uma janela com as opções que queremos que apareça no nosso Eclipse. Nesse caso podemos escolher as opções git Repositories e Git Staging e depois clique em ok. Figura 25 - Configuração Git Staging. Continuação Feita essa configuração temos acesso a seguinte aba demostrada na figura 26, onde se encontra o ficheiro modificado no estado unstaged Changes. Figura 26 - Aba Git Staging IGRP FRAMEWORK OPEN SOURCE 20

22 Próximo passo temos de dar o nosso Commit (Enviar os ficheiros para o nosso repositório local) e Push (Enviar os mesmos para o nosso repositório nas nuvens (GitHub)). Para isso temos de drag and drop o ficheiro modificado para o estado Staged Changes depois escrever a nossa mensagem no Commit Message e clicar no botão Commit and Push. (Ilustrada na Figura 27). Figura 27 - Commit and Push Com isso temos uma janela mostrando o status do nosso push ilustrada na figura 28 e a janela informando que o nosso push foi realizado com sucesso mostrada na figura 29. Figura 28 - Status do Push IGRP FRAMEWORK OPEN SOURCE 21

23 Figura 29 - Mensagem de sucesso de Push Fazendo esses passos demostrados anteriormente, estamos prontos para fazer o Pull Request, que significa fazer um solicitação para o administrador do contributo feito para ser aprovado (merge com o branch principal feito pelo administrador) ou não (closed o pull request). Acessando a sua conta no GitHub e o respectivo repositório, clicando no New Pull Request mostrada na figura 30. IGRP FRAMEWORK OPEN SOURCE 22

24 Figura 30 - New Pull Request Na figura 31 demostra que não houve conflito com o repositório pai, agora é só introduzir o título e a mensagem do Pull request que queremos em seguida clicar no Create pull request. Pronto agora é só aguardar a resposta do administrador do repositório em questão. Figura 31 - New Pull Request. Cont IGRP FRAMEWORK OPEN SOURCE 23

25 Independentemente da contribuição ser aprovada ou não, para rodar a minha aplicação e experimentar o IGRP Frameword na minha máquina, temos de seguir as seguintes passos: 1. Antes de mais nada o servidor tem de estar iniciado, para tal clique direito sobre o servidor e Start (Ilustrada na figura 32). Figura 32 - Start Server IGRP FRAMEWORK OPEN SOURCE 24

26 2. Feito isso, clique direito no projecto igrp, Run as por fim run on server. Figura 33 - Rodar o IGRP Por default o eclipse roda a aplicação dentro do eclipse, mas para mudar isso é só copiar o url e colar no browser da sua preferência (ilustrado na figura 34). Figura 34 - Rodando o IGRP IGRP FRAMEWORK OPEN SOURCE 25