Skip to content

KercX/JavaBooks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

60 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

JavaBooks πŸ“š

Build License Java Version Open Issues

Warning

JUST WARNING

JavaBooks is in active development.This > APIs may change without notice. Use at > your own risk.


πŸ“‹ Project Overview

JavaBooks is a Java library for managing books in console apps, web applications, and games like Minecraft.
It provides add/list/search methods and can be integrated into Java projects, including Spring Boot web apps and game mods.


πŸ“ Project Structure

JavaBooks/β€¨β”‚β€¨β”œβ”€ src/com/javabooks/
│ β”œβ”€ model/Book.java
│ β”œβ”€ service/Library.java
│ └─ Main.javaβ€¨β”‚β€¨β”œβ”€ misc/
│ β”œβ”€ screenshot_console.png
│ └─ screenshot_web.pngβ€¨β”‚β€¨β”œβ”€ examples/
│ β”œβ”€ ExampleConsole.java
│ └─ ExampleWeb.javaβ€¨β”‚β€¨β”œβ”€ .github/workflows/build.ymlβ€¨β”œβ”€ Dockerfileβ€¨β”œβ”€ docker-compose.ymlβ€¨β”œβ”€ LICENSEβ€¨β”œβ”€ CONTRIBUTING.mdβ€¨β”œβ”€ CODE_OF_CONDUCT.md
└─ README.md


πŸ› οΈ Features

  • Add books to library
  • List all books
  • Search books by author or title
  • Ready for integration in web apps and games
  • Console demo included for testing

🌐 Live Demos

Caution

Live demos may not contain all features.


πŸ’» Installation

Clone the repository:

git clone https://github.com/Kercx/JavaBooks

Include the library in your project. Maven:

com.javabooks javabooks 1.0.0

Gradle:

implementation 'com.javabooks:javabooks:1.0.0'

πŸ“š Usage Examples Console Example

import com.javabooks.model.Book;
import com.javabooks.service.Library;

public class ExampleConsole {
    public static void main(String[] args) {
        Library library = new Library();
        library.addBook(new Book("Java Programming", "John Doe", 2022));
        library.addBook(new Book("Minecraft Modding", "Jane Smith", 2023));
        library.listBooks();
        library.searchByAuthor("Jane Smith");
    }
}

Web Example (Spring Boot)

@RestController
@RequestMapping("/books")
public class ExampleWeb {
    private Library library = new Library();

    @GetMapping
    public List to<Book> getAllBooks() {
        return library.getBooks();
    }

    @PostMapping
    public String addBook(@RequestBody Book book) {
        library.addBook(book);
        return "Book added successfully!";
    }
}

Warning

Web example requires Spring Boot dependencies and setup.

🌐 API Endpoints

Method Endpoint Description GET /books Get all books POST /books Add book GET /books/search Search

Docker Install

docker build -t javabooks .
docker run -p 8080:8080 javabooks

πŸ’› Sponsors

Thanks to all organizations and individuals supporting JavaBooks.

🌟 Users & Contributors

Thanks to everyone using JavaBooks and contributing to the project.
Below are amazing GitHub users and contributors!

About

Library to the language programming Java

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors