https://github.com/bernardoadribeiro/sigep

Repositório para desenvolvimento de um Sistema para hotelaria desenvolvido para a disciplina de DSC.
https://github.com/bernardoadribeiro/sigep

Last synced: over 1 year ago
JSON representation

Repositório para desenvolvimento de um Sistema para hotelaria desenvolvido para a disciplina de DSC.

• Host: GitHub
• URL: https://github.com/bernardoadribeiro/sigep
• Owner: bernardoadribeiro
• License: gpl-3.0
• Created: 2022-08-10T22:50:24.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-08T04:18:21.000Z (over 3 years ago)
• Last Synced: 2023-08-03T17:10:57.269Z (almost 3 years ago)
• Language: Java
• Homepage:
• Size: 410 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# SIGEP - Desktop

![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=java&logoColor=white)

![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)

![Apache Maven](https://img.shields.io/badge/Apache%20Maven-C71A36?style=for-the-badge&logo=Apache%20Maven&logoColor=white)

![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)

Repositório para desenvolvimento de um Sistema para hotelaria desenvolvido para a disciplina de DSC.

**Nome do pacote (group_id)**: br.com.sigep

**Nome do artefato (artifact_id)**: sigep

**Responsáveis:**

- Bernardo Ribeiro

- Guilherme Froes

- Hárisson Durães

## Tecnologias utilizadas

Para a construção do sistema, foram utilizadas as seguintes tecnologias:

- **Linguagem:** Java 11

- **Framework:** Java Spring Boot v2.7.2

- **Depedências:** JPA, JDBC API, Lombok, MySQL Driver e Spring Boot DevTools

- **Arquitetura:** MVC

- **Paradigma:** Programação Orienteada a Objetos

- **Controle de versão:** Git

## Padrões do projeto

**Sintaxe | Nomenclaturas:**

- **Pacotes:** `lowercase.example`

- **Classes:** `UpperCamelCase`

- **Variáveis e Métodos:** `lowerCamelCase`

- **Constantes:** `UPPER_SNAKE_CASE`

- **Língua:** pt-BR

**Padrão de commits/branches:** Serão escritos em Português, no formato: `prefixo: descricao`

```Shell

git commit -m 'feat: descricao' # 

git commit -m 'fix: descricao' # 

git commit -m 'docs: descricao' # 

git commit -m 'style: descricao' # 

git commit -m 'refactor: descricao' # 

git commit -m 'perf: descricao' # 

git commit -m 'test: descricao' # 

git commit -m 'build: descricao' # 

git commit -m 'ci: descricao' # 

git commit -m 'chore: descricao' # 

```

**Padrão de comentários no código:** Serão feitos em Português, seguindo o padrão do Google:

```Java

/**

  * Multiplas linhas de texto de Javadoc são escritas aqui,

  * com quebras de linhas normais

 */

 /** Um pedaço especialmente curto de Javadoc. */

```

## Setup do projeto

> Descrever aqui como fazer o setup do projeto na máquina dos colaboradores.

**IDE:** VSCode

Extensões **obrigatórias:** 

   - Java Extension Pack

   - Spring Boot Extension Pack

   - JavaFX Support

   - Lombok Annotation Support for VSCode

**Instruções**

1. Clonar o projeto na sua máquina.

2. ...