Skip to content

Commit 7874bfe

Browse files
author
Shelson Ferrari
committed
ajuste md de arquitetura
1 parent 17eb6b7 commit 7874bfe

1 file changed

Lines changed: 61 additions & 23 deletions

File tree

ARCHITECTURE.md

Lines changed: 61 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -198,26 +198,64 @@ The architecture of this project is designed to be modular and scalable, using D
198198
199199
## Wiki Menu
200200
201-
- [Presentation](https://github.com/33mestre/java_base/wiki/presentation)
202-
- [Project](https://github.com/33mestre/java_base/wiki/project)
203-
- [Technical Definitions](https://github.com/33mestre/java_base/wiki/technical-definitions)
204-
- [Project Structure](https://github.com/33mestre/java_base/wiki/project-structure)
205-
- [Project Components](https://github.com/33mestre/java_base/wiki/project-components)
206-
- [Testing](https://github.com/33mestre/java_base/wiki/testing)
207-
- [Documentation and Swagger](https://github.com/33mestre/java_base/wiki/documentation-and-swagger)
208-
- [Application Execution](https://github.com/33mestre/java_base/wiki/application-execution)
209-
- [H2 Database](https://github.com/33mestre/java_base/wiki/h2-database)
210-
- [CI/CD Pipeline](https://github.com/33mestre/java_base/wiki/ci-cd-pipeline)
211-
- [Configuration Files](https://github.com/33mestre/java_base/wiki/configuration-files)
212-
- [Logs and Best Practices](https://github.com/33mestre/java_base/wiki/logs-and-best-practices)
213-
- [Differentials](https://github.com/33mestre/java_base/wiki/differentials)
214-
- **Project Architecture Documentation**
215-
- [Attachments](https://github.com/33mestre/java_base/wiki/attachments)
216-
- [Licensing](https://github.com/33mestre/java_base/wiki/licensing)
217-
- [Useful Links](https://github.com/33mestre/java_base/wiki/useful-links)
218-
- [Authors](/AUTHORS.md)
219-
- [Code of Conduct](/CODE_OF_CONDUCT.md)
220-
- [Project Change Log](/CHANGELOG.md)
221-
- [Contributing to the Project](/CONTRIBUTING.md)
222-
- [DIRECTORY](/DIRECTORY.md)
223-
- [Planned/Under Study Improvements](/FUTURE.md)
201+
[Home Page](/README.md)
202+
203+
### 1. Introduction to the Project
204+
- [Overview](https://github.com/33mestre/java_base/wiki/overview): Presentation of the project, highlighting its purpose and the context in which it is embedded.
205+
- [Project Objectives](https://github.com/33mestre/java_base/wiki/project-objectives): Enumeration of the main objectives that the project aims to achieve.
206+
- [Scope and Functionalities](https://github.com/33mestre/java_base/wiki/scope-and-functionalities): Description of the main functionalities offered by the project and its scope of operation.
207+
208+
### 2. Configuration and Installation
209+
- [Initial Configurations](https://github.com/33mestre/java_base/wiki/initial-configurations): Steps required to set up the development or production environment.
210+
- [Installation Instructions](https://github.com/33mestre/java_base/wiki/installation-instructions): Detailed procedures for installing the project in different environments.
211+
- [Docker Configuration](https://github.com/33mestre/java_base/wiki/docker-configuration): Specifications on how to configure and use Docker for the project.
212+
213+
### 3. Project Structure
214+
- [Folder Structure](/DIRECTORY.md): Description of the organization of the project directories.
215+
- [Project Architecture](/ARCHITECTURE.md): Explanation of the architecture used, including design patterns and technical decisions.
216+
217+
### 4. Development
218+
- [Development Flow](https://github.com/33mestre/java_base/wiki/development-flow): Description of the development process adopted, including planning, coding, and review stages.
219+
- [Contributors and Authors](/AUTHORS.md): Recognition of the contributors to the project.
220+
- [Contributions](/CONTRIBUTING.md): Guidelines on how to contribute to the project, including code standards and pull request requirements, tips and best practices.
221+
- [Code of Conduct](/CODE_OF_CONDUCT.md): Behavioral guidelines expected for the project community.
222+
223+
### 5. API and Documentation
224+
- [OpenAPI Specification](https://github.com/33mestre/java_base/wiki/openapi-specification): Details about the OpenAPI specification used to document the API endpoints.
225+
- [API Documentation with Swagger](https://github.com/33mestre/java_base/wiki/api-documentation-with-swagger): Information on how to access and use the interactive API documentation generated by Swagger.
226+
- [Javadoc Documentation](https://github.com/33mestre/java_base/wiki/javadoc-documentation): Information on the Javadoc documentation generated for the project.
227+
228+
### 6. Endpoints and Database
229+
- [Endpoint Description](https://github.com/33mestre/java_base/wiki/endpoint-description): Details of the available API endpoints, including methods, parameters, and usage examples.
230+
- [Database Management](https://github.com/33mestre/java_base/wiki/database-management): Strategies and practices for efficient management of the database used by the project.
231+
232+
### 7. Testing
233+
- [Testing Strategies](https://github.com/33mestre/java_base/wiki/testing-strategies): Approach and methods used to test the software, including unit, integration, and E2E tests.
234+
- [Testing Tools](https://github.com/33mestre/java_base/wiki/testing-tools): Description of the testing tools used in the project and how to configure them.
235+
236+
### 8. CI/CD and Automations
237+
- [CI/CD Pipeline](https://github.com/33mestre/java_base/wiki/ci-cd-pipeline): Explanation of the continuous integration and delivery pipeline, detailing each stage and its function.
238+
- [Automations and Artifact Generation](https://github.com/33mestre/java_base/wiki/automations-and-artifact-generation): Description of the automations incorporated into the CI/CD, including documentation generation and build artifacts.
239+
240+
### 9. Configuration Files
241+
- [.gitignore, .editorconfig and project.properties](https://github.com/33mestre/java_base/wiki/gitignore-and-editorconfig-and-project-properties): Utility of these files to maintain code consistency and quality.
242+
- [Maven Wrapper and application.properties](https://github.com/33mestre/java_base/wiki/maven-wrapper-and-application-properties): Explanation of how these files help standardize the development environment.
243+
- [.env File and Travis CI Settings](https://github.com/33mestre/java_base/wiki/env-file-and-travis-ci-settings): Use of these files to configure the environment and CI integrations.
244+
245+
### 10. Best Practices
246+
- [Code Standards and Security](https://github.com/33mestre/java_base/wiki/code-standards-and-security): Guidelines for maintaining code quality and security.
247+
- [Monitoring and Logging Practices](https://github.com/33mestre/java_base/wiki/monitoring-and-logging-practices): Recommended techniques for monitoring and logging in the project.
248+
249+
### 11. Legal and Licensing
250+
- [Licensing](https://github.com/33mestre/java_base/wiki/licensing): Information about the rights and restrictions associated with the use of the software.
251+
- [Terms of Use](https://github.com/33mestre/java_base/wiki/terms-of-use): Information about the terms and conditions for using the software.
252+
253+
### 12. Projections and Innovations
254+
- [Future Plans](/FUTURE.md): Discussion on functionalities and improvements considered for future versions of the project.
255+
- [Improvement Proposals](https://github.com/33mestre/java_base/wiki/improvement-proposals): Space for the community to suggest and debate improvements and innovations.
256+
257+
### 13. Attachments and Useful Links
258+
- [External Links and References](https://github.com/33mestre/java_base/wiki/external-links-and-references): Additional resources and external documentation relevant to the project.
259+
260+
### 14. Security
261+
- [Security Policy](/SECURITY.md): Details on the supported versions, reporting vulnerabilities, and general security practices.

0 commit comments

Comments
 (0)