XYZ Feedback Portal Service

This project builds REST APIs to be consumed by XYZ feedback portal.

Built with SpringBoot + MySQL.

Accessing the deployed API endpoints here.

Running locally

• Open the project with any java IDE (e.g. Eclipse).
• Right Click FeedbackportalServiceRestApplication.java and choose 'Run as java application'.

Deploying

• This project is deployed with Heroku with ClearDB MySQL Add-on.

• Log in to Heroku.

heroku login

• Key in the credential when prompted.
• Push the commited change to Heroku.

git push heroku master

• You may verify deployment by accessing logs.

heroku logs

• To connect to database, you may use Sequal Pro (mac) or MySql Workbench (Windows). Key in host, username and password respectively, which can be found in environment variable JDBC_DATABASE_URL.

heroku run -a [appName] printenv

Reference Documentation

For further reference, please consider the following sections:

• Official Apache Maven documentation
• Spring Boot Maven Plugin Reference Guide
• Create an OCI image
• Spring Web
• Spring Data JPA
• Spring Boot DevTools

Guides

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring
• Accessing Data with JPA
• Accessing data with MySQL