https://github.com/flavio-junior/docs-templete

Documentation of Project
https://github.com/flavio-junior/docs-templete

docs git gitflow github

Last synced: about 2 months ago
JSON representation

Documentation of Project

• Host: GitHub
• URL: https://github.com/flavio-junior/docs-templete
• Owner: flavio-junior
• License: mit
• Created: 2024-11-14T08:34:20.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-14T08:45:13.000Z (about 2 months ago)
• Last Synced: 2024-11-14T09:34:20.190Z (about 2 months ago)
• Topics: docs, git, gitflow, github
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Documentation of Project | Project Name

- **Specifications:**

  - **Programming language used: ` Kotlin `**

  - **Kotlin Version: ` 1.9.25 `**

  - **JDK: ` 21 LTS `**

  - **Maven: ` 3.9.7 `**

- **Tools:**

  - **` IntelliJ IDEA Community Edition `**

  - **` Postman `**

  - **` Git `**

  - **` GitHub `**

  - **` pgAdmin 4 `**

  - **` CMD `**

- **Contact Me:**

  - **Name: ` Flávio Júnior `**

  - **Description: ` Main Developer `**

  - **Contact: ` [email protected] `**

### Git - Accepted Standards for Commits and Pull Requests:

- **feat:** **` Used when creating or adding a new feature. `**

- **fix:** **`  Used when fixing a bug in the project. `**

- **update:** **`  Used for updates to existing files. `**

- **config:** **` Implementation and configuration in the project. `**

- **drop files:** **` Used when a file is deleted from the project. `**

- **docs:** **` Indicates the creation, implementation, or changes in the documentation. `**

- **test:** **` Used when adding or updating test scenarios. `**

- **refactor:** **` Refactoring that does not change functionality. `**

- **build:** **` Indicates the creation, implementation, or changes in build files or dependencies. `**

- **chore:** **` Indicates updates to build tasks, admin configurations, packages, etc. `**

- **perf:** **` Code changes related to performance. `**

- **style:** **`  Used for changes in code formatting. `**

- **revert:** **` Reverts to a specific commit. `**

**Example:** **` git commit -m "docs: adding instructions" `**

### Tree of Branchs:

- **Main: ` Default `**

- **Developer: ` Your Branch `**

# Use Case Diagram:

![ms_ad_use_cases2](https://github.com/user-attachments/assets/f55e2756-88aa-470b-95a2-98d250801ff0)

# Tool Kit:

![326741787-5df62f65-de69-4f21-aead-4ef34835d706](https://github.com/user-attachments/assets/53ce20f4-f51f-465e-b61d-2a956bcc68d7)

# Launch multiple programs

**When your need launch multiple programs, execute this [script](https://github.com/flavio-junior/script-to-init-programs-windows)!**

# Commands

### Commands to generete file .jar:

- **Generate jar: ` mvn clean package `**

- **Generate jar and skip tests: ` mvn clean package -DskipTests `**

- **Run project: ` java -jar target/pontoguia-0.0.1-SNAPSHOT.jar.jar `**

- **Stop project: ` Ctrl + C `**