liwords

Using the full stack on Docker:

1. Download Docker for your operating system

2. Clone the liwords-socket repository from https://github.com/woogles-io/liwords-socket, and place it at the same level as this repo. For example, if your code resides at /home/developer/code, you should have two repos, at /home/developer/code/liwords (this repo) and /home/developer/code/liwords-socket.

3. Clone the macondo repository from https://github.com/domino14/macondo, and place it at the same level as this repo.

4. cd to this directory

5. Run the following command in one of your terminal tabs, to run the backend, frontend, and databases.

docker compose up

1. Edit your hosts file, typically /etc/hosts, by adding this line:

127.0.0.1	liwords.localhost

(If you are on Windows and you want to use Chrome, you cannot use .localhost. Use liwords.local in your C:\Windows\System32\drivers\etc\hosts.)

1. Access the app at http://liwords.localhost
2. If you wish to add a new front-end package, you need to run npm i INSIDE the Docker container. You can do this like: docker compose exec frontend npm i when the docker compose is up.
3. You can register a user by going to http://liwords.localhost/ and clicking on SIGN UP at the top right.

To have two players play each other you must have one browser window in incognito mode, or use another browser.

1. To register a bot, run the script in scripts/utilities/register-bot.sh. You can run it like this:

./scripts/utilities/register-bot.sh BotUsername, replacing BotUsername with your desired bot username.

Tips

You can do docker compose up app and docker compose up frontend in two different terminal windows to bring these up separately. This may be desirable, for example, when making backend changes and not wanting to restart the frontend compilation everytime something changes.

NOTE: These instructions need to be updated and might not work currently.

1. Download Docker for your operating system
2. Download the latest stable version of Node.js for your operating system and install it
3. Download and install Go from golang.org
4. Copy the local_skeleton.env file in this directory to local.env, and modify the copy to match your local paths. (See all the variables ending in _PATH).
5. Open up a few tabs or panels in your terminal so you can bring up the services separately. In each tab, you can do source local.env, or alternatively you can put this command in your profile to do it automatically.
6. Bring up the dc-local-services.yml file with docker compose -f dc-local-services.yml up in one tab.
7. You can bring up the other services in your other tabs:

• For the api server, do go run cmd/liwords-api/*.go
• For the socket server, do go run cmd/socketsrv/main.go in the liwords-socket repo.
• For the frontend, do npm start in the liwords-ui directory.
• For the bot, do go run cmd/bot/*.go in the macondo directory.

1. Go to http://localhost:3000 to see Woogles.
2. You can register a user by clicking on SIGN UP at the top right.

To have two players play each other you must have one browser window in incognito mode, or use another browser.

1. To register a bot, register a user the regular way. Then run this following script, replacing the $1 with the bot username you just registered.

docker compose exec db psql -U postgres liwords -c "UPDATE users SET internal_bot='t' WHERE username = '$1';"