Cyberpunk Shards

This project is a web application that allows users to read in-game notes and books from the game Cyberpunk 2077.

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installing
• Built Using
• Authors
• Acknowledgements
• License

About

This java-application was developed for the purpose of learning how to create a web application using the servlet technology and thyemleaf template engine. Also, the project was developed to learn how to work with the PostgreSQL database and how to deploy a web application on the Heroku platform.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them.

Java 11
Maven
PostgreSQL

sudo apt-get install openjdk-11-jdk
sudo apt-get install maven
sudo apt-get install postgresql

Installing

A step by step series of examples that tell you how to get a development env running.

Clone the repository.

git clone https://github.com/LudwigAndreas/CyberpunkShardsWebSite.git

cd CyberpunkShardsWebSite

Run docker-compose to start the PostgreSQL database.

docker-compose up -d

it will create a database with the name cyberpunk_shards and a user with the name cyberpunk_shards and password cyberpunk_shards.

After that, you need to compile the project.

mvn clean package

And deploy the project on the Tomcat server.

mvn tomcat7:run

Built Using

• Java - Programming language.
• Maven - Dependency Management.
• PostgreSQL - Database.
• Tomcat - Web server.
• Thymeleaf - Template engine.
• Docker - Containerization platform.
• Heroku - Cloud platform.

Authors

This project was developed by:

	LudwigAndreas

Acknowledgements

• NightCityShards and CDcruz for his fantastic website
• Cyberpunk 2077

License

This project is licensed under the MIT License - see the LICENSE file for details.