Project Management API

The Project Management API is a Spring Boot application designed to manage projects. It provides RESTful endpoints for creating, retrieving, updating, and deleting projects. Table of Contents

Features
Technologies
Getting Started
    Prerequisites
    Installation
    H2 database
Usage
API Documentation
Contributing

Features

Create Project: Add new projects to the system.
Get All Projects: Retrieve a list of all projects.
Get Project by ID: Get detailed information about a specific project.
Update Project: Update an existing project's details.
Delete Project: Remove a project from the system.

Technologies

Spring Boot: Framework for building Java-based applications.
Spring Data JPA: Simplifies data access using the JPA specification.
H2 Database: In-memory database for development and testing.
Swagger: API documentation tool for describing and visualizing APIs.

Getting Started

Prerequisites

Java Development Kit (JDK) 8 or higher
Apache Maven or Gradle
IDE (e.g., IntelliJ IDEA, Eclipse) or text editor

Installation

1. Clone the repository: git clone https://github.com/AdityaGore19/Project-management-API.git

2. Navigate to the project directory: cd project-management-api

3. Build the project:If you're using Maven: mvn clean package

4. If you're using Gradle: gradle build

H2 database once you have installed the project on yor machine, to check your local machine database H2, you can go to this and then click connect to see the database you are going to be using

Usage

Run the application:

bash

java -jar target/project-management-api.jar

Access the API:

Open a web browser and go to https://web.postman.co/documentation/27539010-5e8a66fc-df47-451e-a31a-cbbea23c50af/publish?workspaceId=05c7415f-b38d-4b01-865e-fc2eb9886e5f#seo to view the Postman UI and interact with the API endpoints.

API Documentation

API documentation is available using Postman UI. Visit Postman Documentation after starting the application to explore and test the endpoints. Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the project.