Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 2.02 KB

README.md

File metadata and controls

62 lines (51 loc) · 2.02 KB
Raw

Restful API Market

This is an API for the basic operation of a Super Market:

Static Badge Static Badge Static Badge

Running the API with Docker 🚀

To run the API using Docker, follow these steps:

  1. Clone the Repository (if you haven't already):

    git clone https://github.com/leiberbertel/Java-Market-API.git
cd Java-Market

  2. Build the Docker Image:
    Make sure Docker is installed on your machine. Build the Docker image with:

    docker build -t Java-Market

  3. Run the Docker Container:
    After building the image, run the container with:

    docker run -p 8080:8080 Java-Market

  4. Access Swagger UI:
    Once the container is running, you can view the Swagger UI documentation at http://localhost:8080/swagger-ui/index.html#/.

Running the API Without Docker 🚀

To run the API, you will need JDK version 17 installed on your machine. Download it here:

  1. Clone the repository (if you haven't already):

    git clone https://github.com/leiberbertel/Java-Market-API.git
cd Java-Market

  2. Build and Run the Application: 

    ./gradlew build
./gradlew bootRun

    On OS windows:

    gradlew.bat build
gradlew.bat bootRun

The Spring Boot application will launch and be running on port 8080

All endpoints and schemas are documented using Swagger UI. You can view the documentation at http://localhost:8080/swagger-ui/index.html#/, which is the default endpoint for the Swagger UI.

Built with 🛠

  • Gradle - Dependency Handler
  • Java version 17 - Language used
  • Lombok - Tertiary dependency
  • PostgreSQL - Database Engine
  • Spring Framework - Framework used
  • Spring Data JPA - Dependency on data manipulation
  • Springdoc - Dependency on API documentation