How to setup a full environment?¶

Prerequisites¶

Tips

A script in the infra repository can assist you to install the prerequisites software automatically and configure your Github account (OS X only).

To start the procedure, simply run the following command:

bash <(curl -fsSL https://raw.githubusercontent.com/request-yo-racks/infra/master/bootstrap/bootstrap-osx.sh)

At the end of the procedure, your SSH key will be automatically copied to your clipboard and a web page will pop up with the instructions to help you add it to Github.

If nothing pops up, run export RYR_BOOTSTRAP_SILENT=0, then replay the script.

Github¶

A Github account
- With an SSH key
- Added to your Github account

Software¶

Homebrew if you are using OSX
A terminal. The default one is fine, but iterm2 is better
Virtualbox
Docker
NodeJS

Accounts¶

First, you will need:

A Yelp account
A Google account

Developer keys¶

Create a developer Key for:

Yelp Fusion API
Google Maps Platform API Key for Maps and Places

Environment variables¶

Tips

Add the RYR variables to your ~/.bash_profile to avoid exporting them every time:

# Set RYR variables.
export RYR_GLOBAL_CONFIG_DIR="${HOME}/.config/ryr"
export RYR_PROJECT_DIR="${HOME}/projects/request-yo-racks"

Once your accounts are setup, store your developer keys in a global environment file. This file should be located in ~/.config/ryr, which is your configuration directory for the request-yo-racks project.
Export the location of the configuration directory to an environment variable.
```
export RYR_GLOBAL_CONFIG_DIR="${HOME}/.config/ryr"
```

Then create the ryr-env.sh script.

mkdir -p "${RYR_GLOBAL_CONFIG_DIR}"
cat << EOF > "${RYR_GLOBAL_CONFIG_DIR}/ryr-env.sh"
export RYR_COLLECTOR_YELP_API_KEY=foo
export RYR_COLLECTOR_GOOGLE_PLACES_API_KEY=foo
export RYR_WEB_GOOGLE_MAPS_API_KEY=foo
export API_BASE_URL=http://api.192.168.99.100.nip.io/
EOF
chmod 400 "${RYR_GLOBAL_CONFIG_DIR}/ryr-env.sh"

For creating Kubernetes secrets, you need to create one file per key in the ~/.config/ryr/kubernetes-secrets folder.

mkdir -p "${RYR_GLOBAL_CONFIG_DIR}/kubernetes-secrets"
cd "${RYR_GLOBAL_CONFIG_DIR}/kubernetes-secrets"
echo "foo" > RYR_COLLECTOR_YELP_API_KEY
echo "foo" > RYR_COLLECTOR_GOOGLE_PLACES_API_KEY
echo "foo" > RYR_WEB_GOOGLE_MAPS_API_KEY

At the end of the process, your ~/.config/ryr folder should look like this:

[~/.config/ryr] $ tree -L 2
.
├── kubernetes-secrets
│   ├── RYR_COLLECTOR_GOOGLE_PLACES_API_KEY
│   ├── RYR_COLLECTOR_YELP_API_KEY
│   └── RYR_WEB_GOOGLE_MAPS_API_KEY
└── ryr-env.sh

Tips

If for any reasone you need to remove the new line character (\n) in one of the files, refer to this StackExchange post.

Fork the projects¶

Go to the Request Yo Racks organization on Github and fork the infra, api, and web projects (the charts and docs projects are optional as they are no required to run RYR).

Clone or update the projects¶

Configure a folder which will contain the RYR projects.

export RYR_PROJECT_DIR="${HOME}/projects/request-yo-racks"

Configure your Github user.
```
export GH_USER=<your_github_user_name>
```

Clone or update the projects (the charts and docs projects are optional as they are no required to run RYR).

mkdir -p "${RYR_PROJECT_DIR}"
cd "${RYR_PROJECT_DIR}"
for project in api charts docs infra landing-page web; do
  git clone git@github.com:${GH_USER}/${project}.git 2> /dev/null || git -C ${project}/ pull upstream master;
  git -C ${project} remote add upstream git@github.com:request-yo-racks/${project}.git 2> /dev/null;
done

Each project is provided with a Makefile and can be simply setup with the make command.

Start the services¶

External services¶

This will spin up minikube and setup the external services that are required by RYR, like postgresql, redis, rabbitmq.

cd "${RYR_PROJECT_DIR}/infra/kubernetes"
make provision configure

API¶

eval $(minikube docker-env)
cd "${RYR_PROJECT_DIR}/api"
make build-docker deploy-minikube-{api,flower,celery-worker}

Test your setup from a terminal:

curl -X GET \
  'http://api.192.168.99.100.nip.io/1.0/places?location=30.318673580117846,-97.72446155548096'

Or from a web browser: http://api.192.168.99.100.nip.io/1.0/places?location=30.318673580117846,-97.72446155548096

You can also browse the API documentation: http://api.192.168.99.100.nip.io/1.0/ui

Web¶

Notes

Your Google Maps API key will automatically be pulled from the environment variables into the src/config-dev.js file by the Makefile. See the init-config target for more details.

eval $(minikube docker-env)
cd "${RYR_PROJECT_DIR}/web"
npm i
npm run dev

Check the web application:

open http://127.0.0.1:8080