README.md

Bookify

Bookify ktor rest backend is a Kotlin-based RESTful web service built using the [Ktor framework](https://ktor.io/). This backend provides APIs to manage and access books in a library.

Built With • Key Features • Future Tasks • How To Use • Related • License

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Ktor: https://ktor.io
• Kotlin: https://kotlinlang.org
• Exposed: https://github.com/JetBrains/Exposed
• Vue.js: https://vuejs.org
• jawsDB: https://www.jawsdb.com

Key Features

• Search Books with Google Books API
  • Scan ISBN Barcode with integrated Barcode Reader
• Exposed as ORM framework for data manipulation
  • Save, edit and delete Books
• JWT Authentication
• Password Encryption
• SwaggerUI and OpenAPI integration
• Serialization with Jackson
• StatusPages for HTTP Errorhandling

Future Tasks

• Admin Tool
• Implement service layer
• Liquibase for db versioning
• DTOs for object handling in requests
• Tests!
• Share function
• Metrics

How To Use

To clone and run this application, you'll need Git installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/wickenico/bookify-ktor-backend.git

# Go into the repository
$ cd bookify-ktor-backend

# Run the app
$ ./gradlew run

Note Frontend: https://github.com/wickenico/bookify-vuejs-frontend

Related

Support

License