https://github.com/ivancaez/shelfie-ktor

📚 A Ktor server for the Shelfie App
https://github.com/ivancaez/shelfie-ktor

api book kotlin ktor library-management-system

Last synced: 7 days ago
JSON representation

📚 A Ktor server for the Shelfie App

• Host: GitHub
• URL: https://github.com/ivancaez/shelfie-ktor
• Owner: IvanCaEz
• License: agpl-3.0
• Created: 2023-05-21T15:42:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-21T15:44:31.000Z (over 1 year ago)
• Last Synced: 2023-09-19T22:56:24.802Z (about 1 year ago)
• Topics: api, book, kotlin, ktor, library-management-system
• Language: Kotlin
• Homepage:
• Size: 7.85 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Shelfie

## Contents

*   [Description](#description)

*   [Authors](#authors)

*   [Installing](#installing)

*   [Database](#database)

*   [Usage](#usage)

*   [License](#-license)

## Description

Shelfie is consists in an online book lending system. It is like a library but on your cell phone.

## Authors

[Ivan Martinez Cañero](https://gitlab.com/ivan.martinez.7e6)

[Nikita Barbosa Allidi](https://gitlab.com/nikys)

## Installing

Use git to clone this repository into your computer.

> git clone https://gitlab.com/ivan.martinez.7e6/shelfie

> git clone https://gitlab.com/ivan.martinez.7e6/shelfie-android

## Database

Follow this order to create the database and populate it with tables and some info.

If asked, choose PosgreSQL as data source.

You can find and run the scripts in the directory `scripts`:

*   Shelfie

*   Books

*   Users

*   Reviews

*   Book Loans

*   Book Ratings

## Usage

When you've set up the database, you can start the application by running the `Application.kt` file.

Then, you have to start the application using Android Studio and start using Shelfie.

## License

This project is licensed under the [GNU Affero General Public License v3.0](https://choosealicense.com/licenses/agpl-3.0/) 

See the [LICENSE.md](LICENSE) file for details