Skip to content

brunchmade/pinwheel-mac

Repository files navigation

Running Locally

  • Copy .env.sample -> .env and fill out required keys: PUSHER_URL, PUSHER_KEY, SOUNDCLOUD_ID, SOUNDCLOUD_SECRET.
  • Run bundle install.
  • Run bundle exec db:setup.
  • Start your Redis server, typically by running redis-server.
  • Start your Rails server by running foreman start.
  • Visit http://localhost:5000.

Building the Electron Apps

We use Electron to build the Mac app wrapper. To compile your own binaries, run the following scripts from the project root:

Install the electron command globally in your $PATH

npm install electron-prebuilt -g

Production app cd electron && npm install && npm run mac && cd ..

Development app cd electron-beta && npm install && npm run mac && cd ..

Your binary will be created in your /Applications folder.

Environment Variables

Key Required? Notes
PUSHER_KEY ✔️
PUSHER_URL ✔️
SECRET_KEY_BASE ✔️
SOUNDCLOUD_ID ✔️
SOUNDCLOUD_REDIRECT ✔️
SOUNDCLOUD_SECRET ✔️
BUGSNAG_AUTHENTICATION
BUNDLE_GEMFILE
DATABASE_HOST
DATABASE_PORT
MAX_THREADS
PORT
SKYLIGHT_AUTHENTICATION
RACK_ENV
WEB_CONCURRENCY