Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ludwigandreas/cyberpunkshardswebsite
This project is a web application that allows users to read in-game notes and books from the game Cyberpunk 2077.
https://github.com/ludwigandreas/cyberpunkshardswebsite
Last synced: 4 days ago
JSON representation
This project is a web application that allows users to read in-game notes and books from the game Cyberpunk 2077.
- Host: GitHub
- URL: https://github.com/ludwigandreas/cyberpunkshardswebsite
- Owner: LudwigAndreas
- License: mit
- Created: 2022-11-29T09:43:21.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T18:01:39.000Z (7 months ago)
- Last Synced: 2024-11-07T12:47:39.103Z (about 2 months ago)
- Language: Java
- Homepage:
- Size: 11.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#about)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Built Using](#built-using)
- [Authors](#authors)
- [Acknowledgements](#acknowledgements)
- [License](#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.
```text
Java 11
Maven
PostgreSQL
```
```bash
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.
```bash
git clone https://github.com/LudwigAndreas/CyberpunkShardsWebSite.git
cd CyberpunkShardsWebSite
```
Run docker-compose to start the PostgreSQL database.
```bash
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.
```bash
mvn clean package
```
And deploy the project on the Tomcat server.
```bash
mvn tomcat7:run
```
## Built Using
- [Java](https://www.java.com/) - Programming language.
- [Maven](https://maven.apache.org/) - Dependency Management.
- [PostgreSQL](https://www.postgresql.org/) - Database.
- [Tomcat](http://tomcat.apache.org/) - Web server.
- [Thymeleaf](https://www.thymeleaf.org/) - Template engine.
- [Docker](https://www.docker.com/) - Containerization platform.
- [Heroku](https://www.heroku.com/) - Cloud platform.
## Authors
This project was developed by:
| 
|[LudwigAndreas](https://github.com/LudwigAndreas)|
| --- | --- |
## Acknowledgements
- [NightCityShards and CDcruz for his fantastic website](https://nightcityshards.net/)
- [Cyberpunk 2077](https://www.cyberpunk.net/)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.