https://github.com/caarmen/poet-assistant-server

REST API for English-language tools for writing poetry (Spring boot)
https://github.com/caarmen/poet-assistant-server

java kotlin rest-api scala spring-boot

Last synced: 11 days ago
JSON representation

REST API for English-language tools for writing poetry (Spring boot)

• Host: GitHub
• URL: https://github.com/caarmen/poet-assistant-server
• Owner: caarmen
• License: other
• Created: 2021-11-24T21:24:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-18T14:52:08.000Z (almost 3 years ago)
• Last Synced: 2023-03-24T00:21:40.817Z (over 1 year ago)
• Topics: java, kotlin, rest-api, scala, spring-boot
• Language: Kotlin
• Homepage:
• Size: 16.8 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-dictionary-wordnet.txt

Awesome Lists containing this project

README

        
# Poet Assistant Server

This server contains a read-only embedded database with dictionaries for rhymes, synonyms/antonyms and definitions.

Refer to the [documentation](https://caarmen.github.io/poet-assistant-server)

for the list of endpoints and how to use them.

## Test it out

The app is available on heroku: https://poet-assistant-rest.herokuapp.com/

## Architecture

The app contains the following modules:



* Bottom:

  - `repository`: Accesses the database and exposes functions to retrieve Entities

* Top:

  - `api`: Defines the REST endpoints

* Middle:

  - `service`:  Contains the business logic required to map Entities to Model objects

* Other:

  - `doc`: Generates documentation

  - `app`: Contains the application class

## Tech stack

The main branch is implemented in Kotlin with Spring Boot and Gradle.

There are other branches of this project, using other implementations. They may not be as up-to-date as the main branch:

* [Scala (Spring Boot, Gradle)](https://github.com/caarmen/poet-assistant-server/tree/scala)

* [Java (Spring Boot, Gradle)](https://github.com/caarmen/poet-assistant-server/tree/java)