Development Info

For development of WebGSM.

Docker

Commands

1. docker ps - List all docker containers.
2. docker rm XXX - Remove the docker containers, enter the first 3 characters of the docker container.
3. docker images -a - List all docker images.
4. docker rmi XXX - Remove specific docker image, enter the first 3 characters of the docker image.
5. docker image prune - Remove all unused images.
6. docker image prune -a - remove all unused images (not just dangling ones).
7. docker rmi - Removed all docker images (use with caution).
8. docker compose pull - Update docker container.
9. docker compose up --build - Rebuild the container.
10. docker-compose up -d - start container in background.

Software

Git

Submodules

1. git submodule add https://github.com/GameServerManagers/docker-gameserver.git docker-gameserver
2. To update the submodule git submodule update --remote

Dependencies

Every time we update the release branch, we need to update the requirments.txt to do this in the project terminal run pip freeze > requirements.txt Copy the output into the requirements.txt file, and you are good to push the files.

To update pip requirements.txt.

pip freeze --local | grep -v '^\-e' | cut -d = -f 1 | xargs -n1 pip install -U
pip freeze > requirements.txt

# List all installed packages in the current Python environment along with their versions
# --local flag ensures only packages in the current virtual environment are listed
pip freeze --local |

# Filter out any lines that start with '-e', which typically indicates editable installations
# Excluding these lines from further processing
grep -v '^\-e' |

# Split each line by the equal sign '=' delimiter and extract the first field (package name)
# This step removes version information from the package list
cut -d = -f 1 |

# Take each package name from the previous step (one at a time) and run 'pip install -U'
# This upgrades the package to the latest version
xargs -n1 pip install -U

# Save the list of installed packages along with their versions to a file named 'requirements.txt'
# This file is commonly used to specify the dependencies of a Python project
pip freeze > requirements.txt