# `awscdk-minecraft` 🧱
[](https://pypi.org/project/awscdk-minecraft/)
[](./LICENSE.txt)
<img src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/minecraft-selfie.png?raw=true" style="width: 100%;"/>
The goal of this project is to make a single pip-installable package that allows anyone
to provision an entire, *cheap*, Minecraft-server-hosting Platform as a Service to their
personal Amazon Web Services account.
<!-- hrefs to images are absolute URLs to GitHub so that they work on PyPI -->
<figure style="width: 500px; text-align: center;">
<p style="padding: 10px">Login</p>
<img src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/hosted-ui.png?raw=true" style="width: 100%;"/>
</figure>
<figure style="width: 500px; text-align: center;">
<p style="padding: 10px">Start a server</p>
<img src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/server-offline.png?raw=true" style="width: 100%;"/>
</figure>
<figure style="width: 500px; text-align: center;">
<p style="padding: 10px">Get the IP address</p>
<img src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/server-online.png?raw=true" style="width: 100%;"/>
</figure>
<figure style="width: 500px; text-align: center;">
<p style="padding: 10px">Connect</p>
<img src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/enter-ip.png?raw=true" style="width: 100%;"/>
</figure>
<figure style="width: 500px; text-align: center;">
<p style="padding: 10px">Play!</p>
<img src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/phitoduck-joined-game.png?raw=true" style="width: 100%;"/>
</figure>
## Usage
### (1) Be sure to have the the following installed:
- [Python](https://www.python.org/downloads/) 3.8 or higher
- [NodeJS](https://nodejs.org/en/download/) 14 or higher (a dependency of the AWS CDK CLI)
- [AWS CDK CLI](https://docs.aws.amazon.com/cdk/latest/guide/cli.html)
- [Docker](https://docs.docker.com/get-docker/) (should be installed and *running*)
> Note: This library makes use of some of AWS's public docker images. [You will need to log into](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html) AWS's public docker registry (public.ecr.aws).
```bash
# get a temporary login session to public.ecr.aws
aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws
```
### (2) Install the AWS CDK stack exposed by this package
```bash
pip install awscdk-minecraft
```
### (3) Use it in your CDK app
```python
# app.py
import os
from aws_cdk import App, Environment
from cdk_minecraft import MinecraftPaasStack
APP = App()
MinecraftPaasStack(
APP,
"awscdk-minecraft",
# login_page_domain_name_prefix just needs to be unique across all AWS accounts
login_page_domain_name_prefix="mlops-club-minecraft-login"
)
APP.synth()
```
> Note: `app.py` is an AWS Cloud Development Kit concept. If you are not familiar with
> AWS CDK and what an `app.py` file is, you can read more about it in the [AWS CDK docs](https://aws.amazon.com/cdk/).
### (4) Create a Cognito User in the AWS Console
You will need to register a user in AWS Cognito UI so that you can log into the website
deployed by the stack. A Cognito User Pool is created by the stack for this purpose. You
can create a user in that user pool. It will be in whichever region you deployed the stack to.
### (5) Play!
One of the stack outputs will be the URL of the Minecraft Platform frontend. Visit the
site, log in, and start your server!
Share this link with friends and create Cognito users for them as well if you
want them to be able to start and stop the server, too.
Otherwise, just share the IP address with any friends you'd like to be able to join the game.
## Advanced Usage
> 📌 **Note:** For a complete, working example of the advanced usage, you can refer to
[this other repository](https://github.com/phitoduck/cousin-minecraft-server/blob/main/infrastructure/app.py).
### Pretty domain name
You can add the components of your minecraft stack as subdomains of a custom
domain name.
You will need to have a domain name registered with AWS Route53.
For example, for the domain `mlops-club.org` you can create these mappings:
- `minecraft-paas.mlops-club.org` -> the PaaS UI to start/stop the server
- `server.minecraft-paas.mlops-club.org` -> the minecraft server, whenever the EC2 instance is running
```python
# app.py
import os
from aws_cdk import App, Environment
from cdk_minecraft import MinecraftPaasStack
APP = App()
MinecraftPaasStack(
APP,
"awscdk-minecraft",
# login_page_domain_name_prefix just needs to be unique across all AWS accounts
login_page_domain_name_prefix="mlops-club-minecraft-login"
)
APP.synth()
```
### Connecting to the server over SSH
After starting a temporary EC2 instance with the minecraft server, you can
connect to it over SSH if you set up a keypair.
1. Create a keypair, for example, using an existing SSH keypair.
```bash
# create a new keypair from ~/.ssh/id_rsa.pub
SSH_KEY_PAIR_NAME=eric-key
aws ec2 import-key-pair --key-name $SSH_KEY_PAIR_NAME --public-key-material file://~/.ssh/id_rsa.pub --profile <your-aws-profile> --region <your-minecraft-aws-region>
```
If you have trouble with this command, you can always create the key pair in the AWS Console.
2. Register the keypair with your stack.
```python
# app.py
...
MinecraftPaasStack(
APP,
"awscdk-minecraft",
...
ssh_key_pair_name="my-keypair",
)
...
```
3. Connect to the instance when the server is running.
```bash
ssh -i ~/.ssh/id_rsa ec2-user@<instance-ip-address>
```
### Customizing the server and running commands as admin
The Minecraft server runs on the EC2 instance using `docker-compose`.
The container is called `itzg/docker-minecraft-server`. Specifically, using an
optimized Minecraft server JAR called [Paper](https://papermc.io/).
Paper is
a fork of the popular [Spigot](https://www.spigotmc.org/) server, which in turn
is a fork of CraftBukkit. Spigot and Bukkit "plugins" (mods) like [WorldEdit](https://dev.bukkit.org/projects/worldedit) are supported by Paper.
The file structure of the server is like this:
```text
/minecraft
├── docker-compose.yml
└── minecraft-data/ # mounted volume
├── ...
└── server.properties
```
To issue commands on the server:
```bash
# connect to the instance
ssh -i ~/.ssh/id_rsa ec2-user@<instance-ip-address>
# operate as root to have docker privileges
sudo su
# start an RCON session
docker exec -i minecraft rcon-cli
```
*Much* more detailed documentation for operating the minecraft server
can be found in the `itzg/docker-minecraft-server` docs:
[](https://docker-minecraft-server.readthedocs.io/en/latest/)
> Image taken from [itzg/docker-minecraft-server](https://github.com/itzg/docker-minecraft-server)
## Contributing
This project started as a December 2022 month-long Hackathon.
Contributors can expect to come away with an enviable amount of real-world cloud architecture
experience :D
### Architecture
<img src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/awscdk-minecraft-architecture.png?raw=true" style="width: 100%;"/>
The project has 5 components:
1. `awscdk-minecraft/` the Python package. Uses AWS CDK to create the infrastructure.
The other folders in this repository are artifacts that this package includes (and deploys!).
2. `minecraft-platform-frontend/` a React/TypeScript website where users can start/stop a Minecraft server.
The `awscdk-minecraft` package deploys this as a static website in an S3 bucket.
3. `minecraft-platform-backend-api/` a REST API written with the FastAPI framework that facilitates
the functionality exposed in the frontend. The `awscdk-minecraft` package deploys this API
as in a serverless way using AWS Lambda, API Gateway, and Cognito.
4. `minecraft-platform-backup-service` a sidecar container that runs alongside the `itzg/minecraft-server` container
(the Minecraft server) on the EC2 instance. It backs up the save files every N minutes, and restores from
the most recent backup when the EC2 starts up.
5. `awscdk-minecraft-server-deployer/` another AWS CDK package. This package is specifically responsible
for creating and destroying an EC2 instance with the Minecraft server application running on it.
This package itself is built into a Docker image. The `awscdk-minecraft` package
builds the Docker image with this package inside. Then, when users ask the `minecraft-platform-backend-api`
to create or destroy a Minecraft server. The REST API runs an instance of this Docker image
which actually carries out the request.
The setup has only been tested for Linux and MacOS, not Windows :(.
If you're on windows, you'll have the best contributor experience using the Windows Subsystem for Linux 2 (WSL2).
## Useful links
> 💡 Click the images to go to each collaboration tool.
> 💡 Bookmark this repository so you can get quick access to these links.
| | |
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| <a href="https://app.gather.town/invite?token=f8SJlx7bS9KO6cOWvqIW" target="_blank"><img style="float: left; width: 300px; height: 100%; background-size: cover;" src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/gather-town.png?raw=true"></a> <br/>Our virtual park (for remote collab) | <a href="https://join.slack.com/t/rootskiio/shared_invite/zt-13avx8j84-mocJVx5wFAGNf5wUuy07OA" target="_blank"><img style="float: left; width: 300px; height: 100%; background-size: cover;" src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/slack.png?raw=true"></a> <br/>Slack, in the `#hackathon` channel |
| <a href="https://www.figma.com/file/LzVP5Ed3i7NQqOkw6YbMVG/Untitled?node-id=0%3A1&t=uW2UsnZVnTNStUjm-1" target="_blank"><img style="float: left; width: 300px; height: 100%; background-size: cover;" src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/roadmap.png?raw=true"></a> <br/>Roadmap, tasks | <a href="https://www.figma.com/file/6y4vDowRkIZPTYOztIxgy7/Minecraft-Architecture?node-id=0%3A1&t=5JKxB5ylSnLLDZ4b-1" target="_blank"><img style="float: left; width: 300px; height: 100%; background-size: cover;" src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/figma-architecture.png?raw=true"></a> <br/>Architecture |
| <a href="https://d-926768adcc.awsapps.com/start" target="_blank"><img style="float: left; width: 300px; height: 100%; background-size: cover;" src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/aws-console-login.png?raw=true"></a> <br/>`mlops-club` AWS account login page | <a href="https://docs.rootski.io/" target="_blank"><img style="float: left; width: 300px; height: 100%; background-size: cover;" src="https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/rootski.png?raw=true"></a> <br/>Similar project with reference code / resources |
### How do I run this project locally?
TL;DR, install `node` and `just`.
```
# install "just"; it's like "make", but less frustrating
brew install just
# install the project's python packages and pre-commit
just install
```
Alternatively, without `brew`:
```
curl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to <DEST IN YOUR PATH>
```
where `DEST IN YOUR PATH` refers to a directory that is present in your `$PATH` environment variable. For example, you might have in your `~/.bashrc` the line `PATH=~/bin:$PATH` to look for programs in `~/bin` first, which would be the "DEST" supplied above.
You also need `node` to execute any code related to AWS CDK, which you can install with `brew install nvm` and `nvm install 18`.
### How do I add code?
#### Branching strategy: trunk-based development with feature branches
We use pull requests. Create new branches based on `trunk` for experimentation, then open a PR for it.
You don't have to wait until you want to merge code to open a PR. For this project, the main purpose of doing PRs
is to share knowledge and get early feedback on your ideas.
#### Linting
Passing the `pre-commit` checks isn't a huge deal. They are mostly for your own benefit to prevent you
committing things to the repo that you don't want. You can always override `pre-commit` by running
```bash
# run all of the quality checking tools against your code
just lint
```
```bash
# skip the quality checking tools locally
git commit -m "I really want to commit this large file" --no-verify
```
#### Git configuration
> 📌 Note: you may want to use a different email/username for this repository than
> you typically use on your development machine. You can set your git settings locally
> like so:
```bash
git config --local user.email my-personal-email@gmail.com
git config --local user.user my-github-username
```
#### Notes on commits
DON'T COMMIT...
- credentials. Feel free to put them in a `.env` file, but make sure it's gitignored!
- large files (large CSV, ML model weights, C binaries, video, etc.)
use git LFS rather than committing it directly.
- unformatted code
The pre-commit hooks setup for this repo when you ran `just install` will remind you
about these each time you commit :)
Features
- [ ] Custom URL for site
- [ ] Custom URL for minecraft server
- [ ] Specify existing SSH key pair to look up
- [ ] Specify server version
Raw data
{
"_id": null,
"home_page": "https://github.com/mlops-club/awscdk-minecraft",
"name": "awscdk-minecraft",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Minecraft,AWS CDK",
"author": "The MLOps Club",
"author_email": "",
"download_url": "",
"platform": null,
"description": "# `awscdk-minecraft` \ud83e\uddf1\n\n[](https://pypi.org/project/awscdk-minecraft/)\n\n[](./LICENSE.txt)\n\n<img src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/minecraft-selfie.png?raw=true\" style=\"width: 100%;\"/>\n\nThe goal of this project is to make a single pip-installable package that allows anyone\nto provision an entire, *cheap*, Minecraft-server-hosting Platform as a Service to their\npersonal Amazon Web Services account.\n\n<!-- hrefs to images are absolute URLs to GitHub so that they work on PyPI -->\n\n<figure style=\"width: 500px; text-align: center;\">\n<p style=\"padding: 10px\">Login</p>\n<img src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/hosted-ui.png?raw=true\" style=\"width: 100%;\"/>\n</figure>\n\n<figure style=\"width: 500px; text-align: center;\">\n<p style=\"padding: 10px\">Start a server</p>\n<img src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/server-offline.png?raw=true\" style=\"width: 100%;\"/>\n</figure>\n\n<figure style=\"width: 500px; text-align: center;\">\n<p style=\"padding: 10px\">Get the IP address</p>\n<img src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/server-online.png?raw=true\" style=\"width: 100%;\"/>\n</figure>\n\n<figure style=\"width: 500px; text-align: center;\">\n<p style=\"padding: 10px\">Connect</p>\n<img src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/enter-ip.png?raw=true\" style=\"width: 100%;\"/>\n</figure>\n\n<figure style=\"width: 500px; text-align: center;\">\n<p style=\"padding: 10px\">Play!</p>\n<img src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/ui/phitoduck-joined-game.png?raw=true\" style=\"width: 100%;\"/>\n</figure>\n\n## Usage\n\n### (1) Be sure to have the the following installed:\n\n- [Python](https://www.python.org/downloads/) 3.8 or higher\n- [NodeJS](https://nodejs.org/en/download/) 14 or higher (a dependency of the AWS CDK CLI)\n- [AWS CDK CLI](https://docs.aws.amazon.com/cdk/latest/guide/cli.html)\n- [Docker](https://docs.docker.com/get-docker/) (should be installed and *running*)\n\n> Note: This library makes use of some of AWS's public docker images. [You will need to log into](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html) AWS's public docker registry (public.ecr.aws).\n\n```bash\n# get a temporary login session to public.ecr.aws\naws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws\n```\n\n### (2) Install the AWS CDK stack exposed by this package\n\n```bash\npip install awscdk-minecraft\n```\n\n### (3) Use it in your CDK app\n\n```python\n# app.py\nimport os\n\nfrom aws_cdk import App, Environment\nfrom cdk_minecraft import MinecraftPaasStack\n\nAPP = App()\n\nMinecraftPaasStack(\n APP,\n \"awscdk-minecraft\",\n # login_page_domain_name_prefix just needs to be unique across all AWS accounts\n login_page_domain_name_prefix=\"mlops-club-minecraft-login\"\n)\n\nAPP.synth()\n```\n\n> Note: `app.py` is an AWS Cloud Development Kit concept. If you are not familiar with\n> AWS CDK and what an `app.py` file is, you can read more about it in the [AWS CDK docs](https://aws.amazon.com/cdk/).\n\n### (4) Create a Cognito User in the AWS Console\n\nYou will need to register a user in AWS Cognito UI so that you can log into the website\ndeployed by the stack. A Cognito User Pool is created by the stack for this purpose. You\ncan create a user in that user pool. It will be in whichever region you deployed the stack to.\n\n### (5) Play!\n\nOne of the stack outputs will be the URL of the Minecraft Platform frontend. Visit the\nsite, log in, and start your server!\n\nShare this link with friends and create Cognito users for them as well if you\nwant them to be able to start and stop the server, too.\n\nOtherwise, just share the IP address with any friends you'd like to be able to join the game.\n\n## Advanced Usage\n\n> \ud83d\udccc **Note:** For a complete, working example of the advanced usage, you can refer to\n[this other repository](https://github.com/phitoduck/cousin-minecraft-server/blob/main/infrastructure/app.py).\n\n### Pretty domain name\n\nYou can add the components of your minecraft stack as subdomains of a custom\ndomain name.\n\nYou will need to have a domain name registered with AWS Route53.\n\nFor example, for the domain `mlops-club.org` you can create these mappings:\n\n- `minecraft-paas.mlops-club.org` -> the PaaS UI to start/stop the server\n- `server.minecraft-paas.mlops-club.org` -> the minecraft server, whenever the EC2 instance is running\n\n```python\n# app.py\nimport os\n\nfrom aws_cdk import App, Environment\nfrom cdk_minecraft import MinecraftPaasStack\n\nAPP = App()\n\nMinecraftPaasStack(\n APP,\n \"awscdk-minecraft\",\n # login_page_domain_name_prefix just needs to be unique across all AWS accounts\n login_page_domain_name_prefix=\"mlops-club-minecraft-login\"\n)\n\nAPP.synth()\n```\n\n### Connecting to the server over SSH\n\nAfter starting a temporary EC2 instance with the minecraft server, you can\nconnect to it over SSH if you set up a keypair.\n\n1. Create a keypair, for example, using an existing SSH keypair.\n\n ```bash\n # create a new keypair from ~/.ssh/id_rsa.pub\n SSH_KEY_PAIR_NAME=eric-key\n aws ec2 import-key-pair --key-name $SSH_KEY_PAIR_NAME --public-key-material file://~/.ssh/id_rsa.pub --profile <your-aws-profile> --region <your-minecraft-aws-region>\n ```\n\n If you have trouble with this command, you can always create the key pair in the AWS Console.\n\n2. Register the keypair with your stack.\n\n ```python\n # app.py\n\n ...\n\n MinecraftPaasStack(\n APP,\n \"awscdk-minecraft\",\n ...\n ssh_key_pair_name=\"my-keypair\",\n )\n\n ...\n ```\n\n3. Connect to the instance when the server is running.\n\n ```bash\n ssh -i ~/.ssh/id_rsa ec2-user@<instance-ip-address>\n ```\n\n### Customizing the server and running commands as admin\n\nThe Minecraft server runs on the EC2 instance using `docker-compose`.\n\nThe container is called `itzg/docker-minecraft-server`. Specifically, using an\noptimized Minecraft server JAR called [Paper](https://papermc.io/).\n\nPaper is\na fork of the popular [Spigot](https://www.spigotmc.org/) server, which in turn\nis a fork of CraftBukkit. Spigot and Bukkit \"plugins\" (mods) like [WorldEdit](https://dev.bukkit.org/projects/worldedit) are supported by Paper.\n\nThe file structure of the server is like this:\n\n```text\n/minecraft\n\u251c\u2500\u2500 docker-compose.yml\n\u2514\u2500\u2500 minecraft-data/ # mounted volume\n \u251c\u2500\u2500 ...\n \u2514\u2500\u2500 server.properties\n```\n\nTo issue commands on the server:\n\n```bash\n# connect to the instance\nssh -i ~/.ssh/id_rsa ec2-user@<instance-ip-address>\n\n# operate as root to have docker privileges\nsudo su\n\n# start an RCON session\ndocker exec -i minecraft rcon-cli\n```\n\n*Much* more detailed documentation for operating the minecraft server\ncan be found in the `itzg/docker-minecraft-server` docs:\n\n[](https://docker-minecraft-server.readthedocs.io/en/latest/)\n\n> Image taken from [itzg/docker-minecraft-server](https://github.com/itzg/docker-minecraft-server)\n\n## Contributing\n\nThis project started as a December 2022 month-long Hackathon.\n\nContributors can expect to come away with an enviable amount of real-world cloud architecture\nexperience :D\n\n### Architecture\n\n<img src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/awscdk-minecraft-architecture.png?raw=true\" style=\"width: 100%;\"/>\n\nThe project has 5 components:\n\n1. `awscdk-minecraft/` the Python package. Uses AWS CDK to create the infrastructure.\n The other folders in this repository are artifacts that this package includes (and deploys!).\n2. `minecraft-platform-frontend/` a React/TypeScript website where users can start/stop a Minecraft server.\n The `awscdk-minecraft` package deploys this as a static website in an S3 bucket.\n3. `minecraft-platform-backend-api/` a REST API written with the FastAPI framework that facilitates\n the functionality exposed in the frontend. The `awscdk-minecraft` package deploys this API\n as in a serverless way using AWS Lambda, API Gateway, and Cognito.\n4. `minecraft-platform-backup-service` a sidecar container that runs alongside the `itzg/minecraft-server` container\n (the Minecraft server) on the EC2 instance. It backs up the save files every N minutes, and restores from\n the most recent backup when the EC2 starts up.\n5. `awscdk-minecraft-server-deployer/` another AWS CDK package. This package is specifically responsible\n for creating and destroying an EC2 instance with the Minecraft server application running on it.\n This package itself is built into a Docker image. The `awscdk-minecraft` package\n builds the Docker image with this package inside. Then, when users ask the `minecraft-platform-backend-api`\n to create or destroy a Minecraft server. The REST API runs an instance of this Docker image\n which actually carries out the request.\n\nThe setup has only been tested for Linux and MacOS, not Windows :(.\nIf you're on windows, you'll have the best contributor experience using the Windows Subsystem for Linux 2 (WSL2).\n\n## Useful links\n\n> \ud83d\udca1 Click the images to go to each collaboration tool.\n\n> \ud83d\udca1 Bookmark this repository so you can get quick access to these links.\n\n| | |\n| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n| <a href=\"https://app.gather.town/invite?token=f8SJlx7bS9KO6cOWvqIW\" target=\"_blank\"><img style=\"float: left; width: 300px; height: 100%; background-size: cover;\" src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/gather-town.png?raw=true\"></a> <br/>Our virtual park (for remote collab) | <a href=\"https://join.slack.com/t/rootskiio/shared_invite/zt-13avx8j84-mocJVx5wFAGNf5wUuy07OA\" target=\"_blank\"><img style=\"float: left; width: 300px; height: 100%; background-size: cover;\" src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/slack.png?raw=true\"></a> <br/>Slack, in the `#hackathon` channel |\n| <a href=\"https://www.figma.com/file/LzVP5Ed3i7NQqOkw6YbMVG/Untitled?node-id=0%3A1&t=uW2UsnZVnTNStUjm-1\" target=\"_blank\"><img style=\"float: left; width: 300px; height: 100%; background-size: cover;\" src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/roadmap.png?raw=true\"></a> <br/>Roadmap, tasks | <a href=\"https://www.figma.com/file/6y4vDowRkIZPTYOztIxgy7/Minecraft-Architecture?node-id=0%3A1&t=5JKxB5ylSnLLDZ4b-1\" target=\"_blank\"><img style=\"float: left; width: 300px; height: 100%; background-size: cover;\" src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/figma-architecture.png?raw=true\"></a> <br/>Architecture |\n| <a href=\"https://d-926768adcc.awsapps.com/start\" target=\"_blank\"><img style=\"float: left; width: 300px; height: 100%; background-size: cover;\" src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/aws-console-login.png?raw=true\"></a> <br/>`mlops-club` AWS account login page | <a href=\"https://docs.rootski.io/\" target=\"_blank\"><img style=\"float: left; width: 300px; height: 100%; background-size: cover;\" src=\"https://github.com/mlops-club/awscdk-minecraft/blob/trunk/docs/rootski.png?raw=true\"></a> <br/>Similar project with reference code / resources |\n\n### How do I run this project locally?\n\nTL;DR, install `node` and `just`.\n\n```\n# install \"just\"; it's like \"make\", but less frustrating\nbrew install just\n\n# install the project's python packages and pre-commit\njust install\n```\n\nAlternatively, without `brew`:\n```\ncurl --proto '=https' --tlsv1.2 -sSf https://just.systems/install.sh | bash -s -- --to <DEST IN YOUR PATH>\n```\n\nwhere `DEST IN YOUR PATH` refers to a directory that is present in your `$PATH` environment variable. For example, you might have in your `~/.bashrc` the line `PATH=~/bin:$PATH` to look for programs in `~/bin` first, which would be the \"DEST\" supplied above.\n\nYou also need `node` to execute any code related to AWS CDK, which you can install with `brew install nvm` and `nvm install 18`.\n\n### How do I add code?\n\n#### Branching strategy: trunk-based development with feature branches\n\nWe use pull requests. Create new branches based on `trunk` for experimentation, then open a PR for it.\nYou don't have to wait until you want to merge code to open a PR. For this project, the main purpose of doing PRs\nis to share knowledge and get early feedback on your ideas.\n\n#### Linting\n\nPassing the `pre-commit` checks isn't a huge deal. They are mostly for your own benefit to prevent you\ncommitting things to the repo that you don't want. You can always override `pre-commit` by running\n\n```bash\n# run all of the quality checking tools against your code\njust lint\n```\n\n```bash\n# skip the quality checking tools locally\ngit commit -m \"I really want to commit this large file\" --no-verify\n```\n\n#### Git configuration\n\n> \ud83d\udccc Note: you may want to use a different email/username for this repository than\n> you typically use on your development machine. You can set your git settings locally\n> like so:\n\n```bash\ngit config --local user.email my-personal-email@gmail.com\ngit config --local user.user my-github-username\n```\n#### Notes on commits\n\nDON'T COMMIT...\n\n- credentials. Feel free to put them in a `.env` file, but make sure it's gitignored!\n- large files (large CSV, ML model weights, C binaries, video, etc.)\n use git LFS rather than committing it directly.\n- unformatted code\n\nThe pre-commit hooks setup for this repo when you ran `just install` will remind you\nabout these each time you commit :)\n\nFeatures\n\n- [ ] Custom URL for site\n- [ ] Custom URL for minecraft server\n- [ ] Specify existing SSH key pair to look up\n- [ ] Specify server version\n",
"bugtrack_url": null,
"license": "MPL 2.0",
"summary": "AWS CDK construct for hosting a Minecraft server Platform-as-a-Service.",
"version": "2.2.0",
"project_urls": {
"Documentation": "https://github.com/mlops-club/awscdk-minecraft",
"Homepage": "https://github.com/mlops-club/awscdk-minecraft",
"Source": "https://github.com/mlops-club/awscdk-minecraft"
},
"split_keywords": [
"minecraft",
"aws cdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "993b2d8377cb534ad654cd5b768585bc93a8a1c5666d6fa0e4f44fa1877b71b5",
"md5": "5d9289a8f4aadfeae0b8badea218e2b1",
"sha256": "35434f7404130889b9418332efc70a392166f2e25a785169d23a88890c7975be"
},
"downloads": -1,
"filename": "awscdk_minecraft-2.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d9289a8f4aadfeae0b8badea218e2b1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 1346125,
"upload_time": "2023-06-26T07:44:48",
"upload_time_iso_8601": "2023-06-26T07:44:48.575168Z",
"url": "https://files.pythonhosted.org/packages/99/3b/2d8377cb534ad654cd5b768585bc93a8a1c5666d6fa0e4f44fa1877b71b5/awscdk_minecraft-2.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-26 07:44:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mlops-club",
"github_project": "awscdk-minecraft",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "awscdk-minecraft"
}
JSON
