Skip to content

Home

Jump to bottom
Eric Lopes Oliveira edited this page Jul 26, 2023 · 3 revisions

This is the DSListV2 wiki!

DSListV2 - RESTful API for List Management - Wiki

Welcome to the wiki for the DSListV2 project!

This repository contains a RESTful API with a backend in Java and Spring Boot, aimed at list management.

Below, you'll find information about the project, its architecture, prerequisites, installation steps, and more.

📖 Introduction

DSListV2 was developed as part of the "Intensivão Java Spring" bootcamp, which took place in July 2023 and was taught by Professor Nelio Alves. The goal of the project is to create a powerful and efficient backend Spring Boot application using Java.

🛠️ Architecture

The project follows the following layer pattern:

  • Frontend: JSON (HTTP Requests)
  • Backend:
  • Controllers
  • DTO (Data Transfer Objects)
  • Transactions
  • Services
  • Entities
  • Repositories
  • Projections

🚀 Getting Started

Cloning the Repository

To clone the repository using SSH Key, run:

git clone git@github.com:olvericc/dsListV2.git

To clone using HTTPS Protocol, run:

git clone https://github.com/olvericc/dsListV2.git

📋 Prerequisites

Before you start working with the project, make sure you have the following tools and technologies installed:

  • IDE: IntelliJ IDEA Ultimate
  • SGBD: DBeaver Community
  • APIs: Postman
  • VCS: Git
  • SDK: JDK 17 LTS (Zulu)
  • Compilation Tool: Maven
  • DB: Postgres
  • DB: H2 Database

🔧 Installation

🐋 Docker

To set up your development environment using Docker, follow these steps:

Navigate to the docker folder in the project root (e.g., C:\dev\ws-java\dsListV2\docker).

Run the following commands in the terminal with the docker-compose.yml file:

docker-compose build

docker-compose up

⌨️ IntelliJ

To run the Spring Boot application using IntelliJ, you can either launch the application via the IDE's build tool or build it in the terminal:

  1. Make sure you have JDK (Java Development Kit) 17 LTS installed and properly configured in the PATH.

  2. Build the JAR package of your Spring Boot application using Maven:

mvn package

  1. Navigate to the folder where the JAR file was generated (e.g., target) and run the application:

cd target

java -jar filename.jar

  1. Replace "filename.jar" with the actual name of the JAR file generated by your application.

The application should now be accessible at http://localhost:8080/ or another configured port.

🚩 Postman

To test your RESTful API using Postman, follow these steps:

  1. Import the API Collection from the following link:

DSListV2 Postman Collection.

  1. Start testing the endpoints by selecting the corresponding request from the collection, filling in any necessary parameters, and clicking the "Send" button to execute the request.

  2. Inspect and validate the response from the server.

🛠️ Built With

The following tools and technologies were used to create this project:

  • Java: Programming language used (Version: 17 LTS)
  • Spring Boot: Framework for building the application (Version: 3.1.2)
  • Maven: Dependency Manager
  • Spring Data JPA: Spring Framework subproject that supports and facilitates JPA (Java Persistence API) integration
  • H2 Database: In-memory database for testing
  • PostgreSQL: Relational database management system (Version: 15.0)

📌 Version

Release 1.0

✒️ Author

Java Backend Developer: Initial part of the project - Eric Lopes Oliveira

📄 License

This project is under Eric Lopes Oliveira's license.

🔍 References

This project was based on the following repository:

github.com/devsuperior/dslist-backend

🎁 Thanks

  • This project is purely for academic purposes.
  • Future plans include adding more libraries and features.
  • A frontend with Angular or React will be added.
  • Deployment will be completed in the next version.

Thank you for visiting the DSListV2 repository! If you have any questions or suggestions, feel free to reach out to the author.

Happy coding! 😊

Clone this wiki locally