Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clintonbrito/address-management-api
This project is the final assessment for the Squadra New Thinkers Bootcamp. It consists of an API for managing addresses, people, and related geographic data.
https://github.com/clintonbrito/address-management-api
docker java oracle-database spring spring-boot sql
Last synced: 24 days ago
JSON representation
This project is the final assessment for the Squadra New Thinkers Bootcamp. It consists of an API for managing addresses, people, and related geographic data.
- Host: GitHub
- URL: https://github.com/clintonbrito/address-management-api
- Owner: clintonbrito
- License: mit
- Created: 2024-10-30T21:34:06.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-04T23:06:45.000Z (about 1 month ago)
- Last Synced: 2024-12-05T00:19:31.215Z (about 1 month ago)
- Topics: docker, java, oracle-database, spring, spring-boot, sql
- Language: Java
- Homepage:
- Size: 80.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Address Management API
This project is the final assessment for the Squadra New Thinkers Bootcamp. It consists of an API for managing addresses, people, and related geographic data, supporting CRUD operations for states, cities, neighborhoods, addresses, and people.
## Requirements
- Java 21
- Maven 3.9.9
- Docker
## Running the project
To run the project, follow these steps:
1. Clone the repository and enter the project directory:
```bash
git clone [email protected]:clintonbrito/address-management-api.git
cd address-management-api
```
2. Now you need to start the Oracle database. To do this, run the following command:
```bash
docker-compose up -d
```
> [!NOTE]
> In case you'd like to see the logs, you can run the command without the `-d` flag or run the following command:
> ```bash
> docker-compose logs -f
> ```
3. Now you can start the application. To do this, run the following command:
```bash
mvn spring-boot:run
```
> [!NOTE]
> The application will be available at `http://localhost:8080`.
[//]: # (## API Documentation)
[//]: # ()
[//]: # (The API documentation is available at `http://localhost:8080/swagger-ui.html`.)
## Endpoints
The API has the following endpoints:
- `/uf`: CRUD operations for states
- `/municipio`: CRUD operations for cities
- `/bairro`: CRUD operations for neighborhoods
- `/pessoa`: CRUD operations for people
## Database
The database is an Oracle database. After starting the docker container, the user `C##JAVA` will be created automatically with its credentials and permissions. The file `criar_usuario_c##java_com_suas_permissões.sql` contains the SQL script to create the user and grant the necessary permissions.
And the file `script_sql_criar_tabelas.sql` contains the SQL script to create the tables.
## Technologies
- Java
- Spring Boot
- Spring Data JPA
- Oracle Database
- Docker
- Maven
- Lombok
- MapStruct
## Architecture
The project follows the MVC architecture. The project is divided into the following packages:
Each entity has its own package with the following structure:
- `controller`: Contains the controllers for the API endpoints
- `dto`: Contains the DTOs for the API
- `mapper`: Contains the mappers for the DTOs
- `model`: Contains the entities for the application
- `repository`: Contains the repositories for the entities
- `service`: Contains the services for the entities
- `util`: Contains utility classes
- `validator`: Contains the validator classes
Besides the entity packages, the project has the following packages:
- `common`: Contains common classes for the application
- `common.exception`: Contains the exception classes for the application
- `GlobalExceptionHandler` file: Contains the global exception handler for the application
Besides the packages, the project has the following files:
- `application.properties`: Contains the application properties
- `criar_usuario_c##java_com_suas_permissões.sql`: Contains the SQL script to create the user and grant the necessary permissions
- `script_sql_criar_tabelas.sql`: Contains the SQL script to create the tables
- `docker-compose.yml`: Contains the Docker Compose file to start the Oracle database
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Author
- [Clinton Brito](https://github.com/clintonbrito)