vijethph / cinematics

A Spring Boot Application that displays basic information about movies.

Cinematics

---

A Spring Boot Application which gives information about movies, and has a database of released movies.
Made with Spring Boot, Thymeleaf and PostgreSQL

📜 Table of Contents

• Screenshots
• About
• Getting Started
• Deployment
• Usage
• Built Using
• Authors
• Acknowledgments

🖼️ Screenshots

ℹ️ About

This is a Spring Boot application which stores a database of released movies. It uses Spring Boot Framework for overall handling, Thymeleaf template engine for displaying and retrieving variables, and PostgreSQL to store the collection of movies.

Users can search for their favourite movies, actors and directors based on name and can view more details about them.

🏁 Getting Started

Follow these instructions in order to get a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on as a live server.

Prerequisites

Java runtime version 11 (JAVA SE 11), Apache Maven>=3.6 and PostgreSQL>=14.0 are required.

After installing, check their versions using these commands

java -version
mvn -v

🧱 Installing

Clone this project and open this project in terminal.

cd cinematics

Replace the following variables in src/main/resources/application.properties file (sample values are given for Docker Compose):

spring.datasource.url=jdbc:postgresql://postgresdb:5432/cinematics?currentSchema=public&user=testcomposeuser&password=Test@123
spring.datasource.username=testcomposeuser
spring.datasource.password=Test@123

And run the project using following command and check the output at https://localhost:8080 in your browser.

mvn spring-boot:run

If it shows any errors then run the following command before executing the above command:

mvn package

or

mvn clean install

This app can also be run with Docker using Dockerfile and docker-compose.yml files as long as the above variables are replaced with suitable values.

🎈 Usage

This application can be used by everyone if it is deployed using the steps in deployment. For usage by a single user, the following steps should be followed:

• After starting the server, and opening https://localhost:8080 your browser, the homepage of application website will be displayed. From there you can navigate to any sections as per your choice.
• Try using any of the search options provided and feel free to browse through the details given. For some of the search options, the results will be displayed at the bottom of the page.

🚀 Deployment

The application can be deployed to Heroku so that everyone can access it through the internet. To do this you must have a Heroku account and a suitable plan. Simply click this badge to deploy the application to Heroku.

Now the project is deployed. It will show an output giving a website address like this:

deployed at

Ask your friends to open up the specified url and use the application.

⛏️ Built Using

• Spring Boot - Server Framework
• Thymeleaf - HTML Template Engine
• PostgreSQL - Relational DBMS

✍️ Authors

• @vijethph - Idea & Full Development

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• Thanks to project sessions conducted by my college.
• Inspiration: Project Ideas for Spring Boot
• References: Spring Boot and Thymeleaf Documentations.