AntoineCheron / todomvc-rest-api-kotlin-ddd

Domain-Driven Design REST API for TodoMVC, implemented with Kotlin and Spring Boot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TODOMVC

This is a fork of my own repository todomvc. Here I only keep the Kotlin implementation of the REST API and apply a Domain Driven Design Architecture.

Here I propose a REST API to enable the design of new versions of TODOMVC that use a backend.

In my opinion, it could be a nice addition to TODOMVC in order to help developers learn how to use a REST API within a MVC frontend. I consider this as an interesting point as the design of frontends using a REST API became an industry standard.

Project Structure

The project structure respect the Kotlin standards, with Gradle. In addition, is follows a Domain Driven Design architecture.

Prerequisites

You need to have:

  • A Java Development Kit (JDK) version 8 or later

How to install?

Open a terminal, go to the folder where you want to save this project and then type:

git clone https://github.com/AntoineCheron/todomvc-rest-api-kotlin-ddd.git
cd todomvc-rest-api-kotlin-ddd

How to run?

./gradlew bootRun

How to use?

The default port of the server is 8080. This can be changed in the same manner as any Spring Boot project. Check Google for more information on that.

You can use the OpenAPI documentation of the REST API to discover how to use it. Its base URL is http://localhost:8080/rest.

Contributing

Simply open an issue to get in touch and propose your contribution.

License

The license of this project is MIT. It lets people do almost anything they want with this project, like making and distributing closed source versions.

About

Domain-Driven Design REST API for TodoMVC, implemented with Kotlin and Spring Boot

License:MIT License


Languages

Language:Kotlin 100.0%