Skip to content

Latest commit

 

History

History
164 lines (93 loc) · 5.65 KB

README.md

File metadata and controls

164 lines (93 loc) · 5.65 KB
Raw

Department API

Demo project for a Spring Boot project building a Department Backend System.

Built With

Getting Started

- Installation Process

  1. Clone project
  2. Open project in you IDE as a Maven project
  3. Ensure all dependencies in the pom.xml file are resolved.

- Software Dependencies

For building and running the application you need:

  • JDK 17
  • Maven 3

For testing the endpoints of the application you need:

  • Postman
  • PostgreSQL or DB of your choice

Build and Test

Build

  • Build the project and run all tests by running the mvn clean package command.
  • Then spin up the application by clicking the run button along the file name tab or the one in DepartmentApplication file right beside the numbers
  • Ensure the db_credentials are added in the yaml file within the resources directory for data transfer
    • Or check application.properties file and get the H2 connections and spin up the in-memory db

Test

  • You can run only tests by running the mvn test command.
  • Navigate to the test directory for the test cases of the respective application layers

License

This project is licensed under the Apache License 2.0.

Acknowledgments

© Victor Shaviya.