https://github.com/guillaumefalourd/kotlin-training-api

Kotlin Rest API for training
https://github.com/guillaumefalourd/kotlin-training-api

Last synced: 8 months ago
JSON representation

Kotlin Rest API for training

• Host: GitHub
• URL: https://github.com/guillaumefalourd/kotlin-training-api
• Owner: GuillaumeFalourd
• License: apache-2.0
• Created: 2023-09-22T17:37:45.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-22T17:48:52.000Z (about 2 years ago)
• Last Synced: 2025-01-12T06:07:12.928Z (9 months ago)
• Language: Kotlin
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Kotlin Training API

[![Security Pipeline](https://github.com/GuillaumeFalourd/kotlin-training-api/actions/workflows/security-pipeline.yml/badge.svg)](https://github.com/GuillaumeFalourd/kotlin-training-api/actions/workflows/security-pipeline.yml) [![Super Linter](https://github.com/GuillaumeFalourd/kotlin-training-api/actions/workflows/super-linter.yml/badge.svg)](https://github.com/GuillaumeFalourd/kotlin-training-api/actions/workflows/super-linter.yml) [![Gitleaks](https://github.com/GuillaumeFalourd/kotlin-training-api/actions/workflows/gitleaks.yml/badge.svg)](https://github.com/GuillaumeFalourd/kotlin-training-api/actions/workflows/gitleaks.yml)

☞ Github repository with challenges to build a Kotlin REST API with Spring, Maven, Hibernate and JPA.

## 📚 Challenges

_TODO_

### Requirements

1. Java - 11

2. Maven - 3.x.x

### Running the App**

Type the following command in your terminal to run the app:

```bash

mvn spring-boot:run

```

The app will start running at .

### Explore Rest APIs

The app defines following CRUD APIs.

    GET /api/users

    

    POST /api/users

    

    GET /api/users/{id}

    

    PUT /api/users/{id}

    

    DELETE /api/users/{id}

You can test them using any Rest Client.

## 🤝 Contributing

☞ If you're interested in contributing to this repository, please follow the [guidelines](https://github.com/GuillaumeFalourd/kotlin-training-api/blob/main/CONTRIBUTING.md)

## 🏅 Licensed

☞ This repository uses the [Apache License 2.0](https://github.com/GuillaumeFalourd/kotlin-training-api/blob/main/LICENSE)