Group Member: Vu Diep, Shridhar Bhardwaj, Shreya Bhattacharya, Aaditya Chaudhari

1. Clone the repository

git clone https://github.com/vudiep411/cpsc449-wordle-backend.git

2. cd into the root directory

cd cpsc449-wordle-backend/

3. Install libraries needed

./bin/requirements.sh

4. In var directory create primary/data and primary/mount, secondary1/data and secondary1/mount, secondary2/data and secondary2/mount

5. Start the server with foreman

foreman start

⚠ leaderboard service will try to connect but won't be able to until database is initilized in the next step

6. Setting up the database

./bin/init.sh

7. Start redis server if haven't

./redis.sh

8. Configure your Nginx similar to nginx.confg
9. Configure your crontab similar to cron.txt

Steps:

1. Start cron using command: crontab -e
2. Configure the content similar to cron.txt
3. Save the changes

⚠ The development server for User service will be started at http://127.0.0.1:5000/
⚠ The 3 development servers for Game service will be started at
http://127.0.0.1:5100/
http://127.0.0.1:5200/
http://127.0.0.1:5300/
⚠ Leaderboard service will be started at http://127.0.0.1:5700/

To access leaderboard data through nginx, visit http://tuffix-vm/leaders

After starting the server with foreman start, go to http://127.0.0.1:5000/docs, http://127.0.0.1:5100/docs, and http://127.0.0.1:5700/docs for all REST API routes example