X-Meme (Spring Boot Backend Project)

About Author

• Name - Subham Kumar Das

• Check out Author's Github Repository

About Project

• This project is developed using Spring Boot in Spring Tool Suite (STS) IDE.

• Database used for project - PostgreSQL

• ORM Tool Used - Hibernate with JPA

• Web API publicly hosted on Heroku

• Angular frontend code is hosted on Github Repository

• The frontend website is hosted in Netlify

API Controllers

1. HomeController

   • Controller associated with rendering home page of Web API.

2. MemeController

   • REST Controller associated with API end points, related to Memes which include fetching memes, uploading memes, updating meme payload.

3. ReviewController

   • REST Controller associated with API end points, related to reviews which include uploading reviews, fetching reviews, etc.

• Documentation of API is hosted in Heroku

Entities

1. Meme

   • Entity which encapsulates Meme structure in database (ORM)

2. Review

   • Entity which encapsulates Review structure in database (ORM)

Exceptions

• MemeException
  • Custom API Exception
• MemeExceptionHandler
  • REST API Exception Handler which catches MemeException and returns ResponseEntity accordingly

Other Modules

• Configuration

  • Contains custom API configuration to be rendered by Swagger Documentation

• Services

  • MemeService - Services related to memes.
  • ReviewService - Services realated Reviews