ENTRETAINMENT API

This is my "portfolio" API, where I will implement some of my backend skills that I've been learning throughout my career as a backend developer.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

The Entertainment API offers a versatile range of dummy event data that can be seamlessly integrated into a wide array of projects. Whether you are working on an application that requires event information, or you simply want to explore and practice working with JSON data, this API is a valuable resource.

The event structure is as follows:

{
  "id": "Event ID",
  "name": "Event Name",
  "description": "Event Description",
  "date": "Event Date",
  "category": "Event Category"
}

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

In order to run this project locally you must have Java 17 and gradle installed on your computer

Installation

1. Clone the repo

   git clone https://github.com/PauSansa/entretainment-api.git

2. Set the database connection in the application.yml

       mongodb:
         uri: your mongodb uri
         username: username
         password: password

3. Run the project using Gradle:
   • On Linux, MacOS or Windows(using powershell)

     ./gradlew bootRun

   • On Windows (using CMD)

       gradlew.bat bootRun 

(back to top)

Usage

WIP

For more examples, please refer to the Documentation

(back to top)

Roadmap

This API includes features like:

• ✅ Pagination
• ✅ All CRUD Operations
• ✅ Reactive Connection to MongoDB
• ✅ Auth with JWT
• 🛠️ Filter events by category
• 🛠️ Create users and check to see if they - already exist
• 💭 Deployment using docker
• 💭 AI generated responses
• 💭 Frontend Documentation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Pau Sansa - [email protected]

Project Link: https://github.com/PauSansa/entretainment-api

(back to top)