Before installng make sure you have the following
Clone the repository
git clone https://github.com/maxkopitz/handsfreerummy- Copy
.env.example
cp ./.env.example .env- Get a key from azure Speach Services
- Populate
.envwith key
NODE_ENV=development
AZURE_TRANSCRIBE_SUBSCRIPTION_KEY=xxxxxxx
AZURE_TRANSCRIBE_REGION=useast
- Build the backend & frontend containers, this step is only needed the first time installing and when package.json or requirements.txt changes.
docker compose build- Run docker compose
docker compose up- The UI should be running at
http://localhost:3000/ - The API should be running at
http://localhost:4000/api/v1/ - Redis Insight should be running at
http://localhost:8001/
Use
CTRL-Cto stop docker compose or docker compose down
├── backend/ Python Flask Backend
│ ├── bin/ Scripts
│ ├── handsfree/ Flask API
│ │ ├── api/ Flask Routes & Sockets
│ │ ├── cli/ Flask CLI
│ │ └── game/ Logic for managing games
│ └── tests/
├── frontend React UI
│ ├── src
│ │ ├── api API Services
│ │ ├── components Components
│ │ │ ├── game Game Components
│ │ │ ├── joingame Displaying lobby game Components
│ │ │ ├── settings Settings Components
│ │ │ ├── tutorial Tutorial Compoents
│ │ │ └── ui Reusable UI Components
│ │ ├── hooks Hook/Reducers
│ │ └── lib Utility
└─────────────────────────
- If you get stuck on a page, go to Redis Insight
http://localhost:8001. - Open the CLI
- Flush the DB by entering
FLUSHDBin the CLI
Issue: Installed package is not installed after running docker compose build and docker compose up
Solution:
- Make sure compose stack is not running
docker compose down- Remove the UI container and its volumes
docker container rm handsfreerummy-client-1 --volumes- Start containers
docker compose up --build