Skip to content

huict/prbed-2122-v2c-teamdit

Repository files navigation

Appline - Project Back End Development

Appline is a back-end application made using Spring Boot. Both the Spring application and the PostgreSQL database can be ran in a Dockerized container.


Cloud Deployment

The Spring Boot application is ran in a Dockerized environment using Heroku's free hosting services, which can be accessed with the following link: https://prbed-team-dit-app.herokuapp.com/

Documentation

All documentation can be found on the Wiki.

Swagger-link local: http://localhost:8080/swagger-ui/#/
Swagger-link live: https://prbed-team-dit-app.herokuapp.com/swagger-ui/#/

Tests

Appline is being tested using Postman.
Tests can be found in here.

Project Setup

  1. Clone the project using your prefered git tool.

  2. Copy example.env and paste it as .env. Do not delete example.env, this is required for deployment.

  3. In your IDE's run configurations, point the environment variables to the .env file or if necessary, insert the variables into your run config manually.

  4. Run maven package
    Maven

  5. Run the application with docker-compose up to deploy the application

    1. Add db or api at the end of the line to only compose one of these services
  6. Tip: Run docker-compose up db, and then run the Spring Boot application through Intellij during development for faster and easier testing

About

prbed-2122-v2c-teamdit created by GitHub Classroom

Resources

Stars

Watchers

Forks

Packages

 
 
 

Languages