Update README to add a Docker Quick Start section
simonprickett opened this issue ยท 3 comments
simonprickett commented
Since we originally wrote the README for this repo, another option for running it has been added. You can now run both the game and Redis in Docker containers. Previously Redis was in a container and the game had to be run locally.
Update the README to reflect this as follows:
Setup Section:
- Split this section into two sub-sections, one for each way of running the game:
- With Docker - you need to have Docker installed and there are no other requirements. You will need to capture the output of
docker-compose up -d
and show that. Retain the information that's currently in the README about how Redis persists the data when used in Docker. Note that when using Docker, there is no need to load the game data as this is done for you. Once the containers are running you should be able to start a game simply by pointing the browser at http://localhost:8080/. Make sure to include information about stopping the containers (docker-compose down
) - Without Docker - you will need Redis 5 or higher, the RedisJSON module and Node.js (current LTS version recommended). Refactor the information in the current README to cover running
npm install
thennpm run load
and checking that the data was loaded, then starting the game withnpm run dev
and stopping it with Ctrl-C.
- With Docker - you need to have Docker installed and there are no other requirements. You will need to capture the output of
The README should stay the same from the "Playing the Game" section onwards.
VedanthB commented
hey, can i take this up
simonprickett commented
@VedanthB absolutely - I've assigned this one to you, please check out our guidelines here: https://developer.redis.com/hacktoberfest/ and we're also on Discord at https://discord.gg/ueQwKUh5Z3
We look forward to receiving your contribution, thanks!
VedanthB commented
I have made the changes and created a PR. Please look into it ๐