Skip to content

Commit 5048800

Browse files
author
Fernando José
committed
Organização do readme #29
1 parent a90e411 commit 5048800

File tree

2 files changed

+114
-83
lines changed

2 files changed

+114
-83
lines changed

README.md

Lines changed: 114 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,68 @@
1-
# Analisador de Pontos de Função
2-
3-
[![Build Status](https://travis-ci.com/labens-ufrn/apf-bsi.svg?branch=master)](https://travis-ci.com/labens-ufrn/apf-bsi)
4-
1+
<!-- Título -->
2+
<h1 align="center">
3+
ANALISADOR DE PONTOS DE FUNÇÃO
4+
</h1>
5+
6+
<!-- Badge_Grade -->
7+
<p align="center">
8+
<img alt="GitHub language count" src="https://img.shields.io/github/languages/count/lukemorales/rocketshoes-react-native.svg">
9+
10+
<a href="https://www.codacy.com/app/lukemorales/rocketshoes-react-native?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=lukemorales/rocketshoes-react-native&amp;utm_campaign=Badge_Grade">
11+
<img alt="Codacy grade" src="https://img.shields.io/codacy/grade/e4cc1482460841bdaa99c2e75e01f0bc.svg">
12+
</a>
13+
14+
<img alt="Repository size" src="https://img.shields.io/github/repo-size/lukemorales/rocketshoes-react-native.svg">
15+
<a href="https://github.com/lukemorales/rocketshoes-react-native/commits/master">
16+
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/lukemorales/rocketshoes-react-native.svg">
17+
</a>
18+
<a href="https://github.com/lukemorales/rocketshoes-react-native/issues">
19+
<img alt="Repository issues" src="https://img.shields.io/github/issues/lukemorales/rocketshoes-react-native.svg">
20+
</a>
21+
<img alt="GitHub" src="https://img.shields.io/github/license/lukemorales/rocketshoes-react-native.svg">
22+
</p>
23+
24+
<!-- Descrição -->
25+
<h4 align="center">
26+
Sistema para a contagem e análise dos pontos de função para estimar o tamanho funcional de um software.
27+
</h4><br><br>
28+
29+
<!-- Links dos tópicos -->
30+
<p align="center"></p>
31+
<a href="#sobre">Sobre o Projeto</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
32+
<a href="#doc">Documentação</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
33+
<a href="#pre">Pré-requisitos</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
34+
<a href="#des">Desenvolvimento</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
35+
<a href="#bui">Build e Execução</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
36+
<a href="#tes">Testes</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
37+
<a href="#lic">Licença</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
38+
<a href="#ref">Referências</a>
39+
</p>
40+
<br>
41+
<a id="sobre"></a>
42+
43+
# Sobre o Projeto
544
Sistema para facilitar a contagem na análise por pontos de função (APF) desenvolvido para ser utilizado nas disciplinas de Engenharia de Software do curso de Bacharelado em Sistemas de Informação do CERES/UFRN.
645

7-
## Documentação do Projeto
8-
9-
* Plano de Iteração
10-
* Documento de Visão
11-
* Lista de User Stories
12-
* Contagem de Tamanho Funcional com Análise por Pontos de Função
13-
14-
## Padrões de Codificação
46+
<a id="doc"></a>
1547

16-
* Insert spaces for tabs
17-
* Tab policy para Spaces only
18-
* Indentation size: 4
19-
* Tab size: 4
48+
# Documentação
49+
* [Documento de Visão](docs/docVisao.md)
50+
* [Plano de Iteração]()
51+
* [Lista de User Stories]()
52+
* [Contagem de Tamanho Funcional com Análise por Pontos de Função]()
2053

21-
## Pré-requisitos
54+
<a id="pre"></a>
2255

23-
* JDK 8
24-
* MariaDB ou MySql
25-
* Criação do Banco de Dados (dev e test) e Usuário
56+
# Pré-requisitos
57+
Para executar o projeto, será necessário instalar os seguintes programas:
58+
* JDK 8: Necessário para executar o projeto Java.
59+
* Maven: Necessário para realizar o build do projeto Java.
60+
* Eclipse ou Vscode + extensões Java: Para o desenvolvimento do Projeto.
61+
* MariaDB ou MySql: para persistência no Banco de Dados
62+
* Criação do Banco de Dados dev e test(apf_db e apf_db_test) e Usuário(apf_user) com sua devidas permissões.
63+
Código abaixo:
2664

65+
1. Criação das bases de dados e usuário
2766
```sql
2867
CREATE DATABASE apf_db;
2968
CREATE DATABASE apf_db_test;
@@ -34,37 +73,79 @@ Sistema para facilitar a contagem na análise por pontos de função (APF) desen
3473
GRANT ALL ON apf_db_test.* TO 'apf_user'@'localhost';
3574
```
3675

37-
* Povoamento do Banco de Dados
38-
76+
2. Povoamento do Banco de Dados
3977
```sql
4078
INSERT INTO role VALUES (1,'ADMIN');
4179
INSERT INTO role VALUES (2,'USER');
4280

4381
INSERT INTO attribution VALUES (1,'PROJECT MANAGER');
4482
INSERT INTO attribution VALUES (2,'PROJECT MEMBER');
4583
```
46-
## Execução
84+
## Padrões de Codificação do Editor
85+
* Insert spaces for tabs
86+
* Tab policy para Spaces only
87+
* Indentation size: 4
88+
* Tab size: 4
89+
90+
91+
<a id="des"></a>
92+
93+
# Desenvolvimento
94+
Para iniciar o desenvolvimento, é necessário clonar o projeto do GitHub num diretório de sua preferência:
95+
```bash
96+
cd "diretório de sua preferência"
97+
git clone https://github.com/labens-ufrn/apf-bsi.git
98+
```
99+
100+
<a id="bui"></a>
101+
102+
# Build e Execução
47103

48104
Esse projeto faz uso do framework spring-boot que encapsula todas as dependências no arquivo jar.
105+
Para o build do projeto, execute os comandos abaixo:
106+
```java
107+
mvn clean
108+
mvn install
109+
Vá para o diretório /target
110+
java -jar apf-bsi-0.0.1-SNAPSHOT.jar
111+
```
112+
O comando irá baixar todas as dependências do projeto e criar um diretório target com os artefatos construídos, que incluem o arquivo jar do projeto. Além disso, serão executados os testes unitários, e se algum falhar, o Maven exibirá essa informação no console.
113+
Se tudo ocorreu como esperado vai conseguir acessar estes endereços com sucesso.
114+
```bash
115+
http://localhost:8080/apf/
116+
http://localhost:8080/apf/login
117+
http://localhost:8080/apf/registration
118+
```
49119

50-
1. mvn clean
51-
2. mvn install
52-
3. Go to the target folder
53-
4. java -jar apf-bsi-0.0.1-SNAPSHOT.jar
120+
<a id="tes"></a>
54121

55-
- http://localhost:8080/apf/
56-
- http://localhost:8080/apf/login
57-
- http://localhost:8080/apf/registration
122+
# Testes
123+
Para rodar os testes, utilize o comando abaixo:
124+
```java
125+
mvn test
126+
```
127+
128+
<a id="lic"></a>
129+
130+
# licença
58131

59-
## Referências
132+
```bash
133+
MIT
134+
```
135+
<a id="ref"></a>
136+
137+
# Referências
60138

61139
Desenvolvido a partir do tutorial e do código linkado abaixo:
62140

141+
63142
* https://medium.com/@gustavo.ponce.ch/spring-boot-spring-mvc-spring-security-mysql-a5d8545d837d
64143
* https://github.com/gustavoponce7/SpringSecurityLoginTutorial
65144
* https://franckaragao.wordpress.com/2016/08/23/integracao-continua-com-o-travis-ci-em-projetos-java-usando-o-maven/
66145
* https://github.com/lowrin/spring-boot-input-autocomplete-example
67146

68-
### Tutoriais
147+
## Tutoriais
148+
- Na página [Tutoriais](docs/Tutorials.md) temos a lista de tutoriais consultados.
149+
## Artigos
150+
- Na página [Artigos](docs/referencias.md) temos a lista de artigos consultados.
69151

70-
Na página [Tutoriais](docs/Tutorials.md) temos a lista de tutoriais consultados.

src/main/resources/application.properties

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)