/vrnotes

An web application for viewing Annotations created in VR

Primary LanguageRuby

README

Local Development

  1. Install ruby. Use ruby version 3.0.2. We recommend using rbenv to manage your ruby versions.

  2. Install yarn.

  3. Clone the repo and cd to the root.

  4. Get a copy of the master.key from another developer and place it at config/master.key. The applicaiton is using Encrypted Credentials to store the AWS keys need to connect to dynamo db.

  5. Install all of the needed libraries by running bundle install.

  6. Run yarn to install frontend dependencies.

  7. Start the server by running rails server.

Deployment instructions

This app is deployed via Heroku on the free tier.

Install the Heroku CLI.

Add the git remote for Heroku with:

heroku git:remote -a radiant-river-88924

Deploy by running:

git push heroku main