Bye Bye Book

A full stack web service designed to collect posts from friends for a personal friendship book. The frontend is a Vue.js browser app providing a simple web form users can fill out. The backend is a Srping Boot RESTful web service which is used to persist the user data storing it in a relational database.

Features

• Provide a web form users can fill out
• Show summary of all posts when run in admin mode
• REST endpoints to store and retrieve posts
• REST endpoints to store and retrieve images
• REST endpoint to download all entries as a *.pdf document

(1) Form to add a post

(2) Summary view of post

(3) REST endpoints

(4) Exported Bye Bye Book

How to run using Docker, Gradle, Node.js on Linux

Build Bye Bye Book client

• $ cd src/bbb-client/
• $ npm install
• $ npm run build

Build Bye Bye Book server

• $ cd src/bbb-server/
• $ ./gradlew build

Start Docker service stack

• $ cd docker/bbb/
• $ docker-compose up (production mode, no access to /api/postings)
• $ docker-compose -f docker-compose_admin.yml up (admin mode, access to /api/postings)
• The following addresses are available:
  • All posts: Overview of all posts present (empty if not running in admin mode)
  • Add a post: Web form to add an entry to the friendship book
  • REST endpoint overview: Overview of all REST endpoints available
  • Generate Bye Bye Book: Generate a friendship book and retrieve a *.pdf document
• Please note that the web server uses self-signed SSL certificates. So the browser will warn you about a "potential security risk ahead". In a production scenario, you would need to replace those certificates of course.

License

• AGPL-3.0-or-later