bonomoon/bookhub-api

Bookhub-API

Go to the Bookhub project repo | Read the Documentation 📚

---

• 📚 Documentation
• 🔭 Project Layout
• 💑 Contributing
• 📑 License

Bookhub-API is a separate project developed using Spring framework to serve Bookhub's APIs. Please refer to README for more information.

📚 Documentation

Learn about building and deploying our apps in our official docs!

• Project Introduction
• Getting Started
• Requirement Specification
• Architecture Design
• API Reference
• Data Modeling & ERD

🔭 Project Layout

Getting Started

Run the following command:

With Gradle command line

cd bookhub-api
./gradlew bootrun

You can then access Bookhub API here: http://localhost:8080/

Working with Bookhub API in your IDE

Prerequisites

The following items should be installed in your system:

• Java 17 or newer (full JDK not a JRE)
• Gradle 7.x+ (https://gradle.org/releases/)
• git command line tool (https://help.github.com/articles/set-up-git)
• Your prefered IDE(recommended IntelliJ IDEA)

Steps:

1. On the command line

git clone https://github.com/bonomoon/bookhub-api.git

2. Inside IntelliJ IDEA

In the main menu, select File > Open and select the Bookhub API project directory. Click on the Open button.

What's inside?

💑 Contributing

Please check links below before commit.

• Git flow, the most git branching model
• Commit rule: Semantic Commit Messages

📑 License

Bong-oh Moon – bongohmoon@gmail.com(bonomoon)

Distributed under the MIT license. See LICENSE for more information.