This is the api for the Where's Waldo app hosted at https://waldo.rankoliang.com/.

The frontend repository for this application can be found at https://github.com/rankoliang/waldo-frontend/.

Techonologies used: react, rails, nginx, redis, docker, AWS.

• Select a level from the homepage.
• Click the image where you see one of the characters.
• Select the character from the dropdown menu
• Repeat until you have found all of the characters for a level.
• Submit your score!

You will need to clone the frontend repository linked again here.

Set up the environment variables at dev.env according to the variables in dev.env.sample in the repository you are running docker-compose from.

You will also need to delete the config/credentials.yml.enc file in the api repository and regenerate your master key by running the commands

bin/dc api sh

to enter the shell of the backend container, followed by

EDITOR="vi" rails credentials:edit

This application uses docker to run.

To set up your development environment, you must have docker and docker-compose installed.

There is a bin/dc script to run docker-compose with the appropriate configurations depending on your environment. There is also a Makefile available where you can run some preselected commands.

With a -p flag, you will run the commands for production and without it, you will run the commands in development mode.

WARNING You will have to change the domain on nginx and the certbot script to run this in production. Certbot may need some additional setup before this repo is ready to be deployed for production.

To build the docker containers, run make build or bin/dc build.

To run the docker containers, run make up or bin/dc up -d.

You can visit localhost at port 3000 to open the site.

• Frontend
  • bin/dc web yarn test
• api
  • bin/dc api bundle exec rspec

See the the Makefile and bin/dc files for more options.