https://github.com/ashfaqbs/bored_api

https://github.com/ashfaqbs/bored_api

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ashfaqbs/bored_api
• Owner: Ashfaqbs
• License: gpl-3.0
• Created: 2023-03-19T02:51:05.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-03-19T03:12:28.000Z (over 1 year ago)
• Last Synced: 2023-11-22T12:36:39.637Z (12 months ago)
• Language: Java
• Size: 30.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bored API

![Demo Gif](https://i.pinimg.com/originals/7d/bd/e6/7dbde6ca4b7d29916fe68af9127ee1ba.gif)

A simple API built with Spring Boot that generates a new task every time it is called.

## Prerequisites

- Java 8 or higher

- Maven

## Getting started

To run the application, clone the repository and navigate to the project directory in your terminal. Then, run the following command:

This will start the application on `localhost:8080`.

## API endpoints

### GET /bored

Generates a new task.

**Example response:**

     type-String 

     Write a short story

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.