README.md

Octave README

Description

Octave is a place to collaborate and share information.

Technologies

Octave is built with:

• Vulcan, the “full-stack React+GraphQL framework,” built with:
  • React
  • GraphQL
  • Meteor
  • Apollo
  • MongoDB
• Bootstrap (react-boostrap, SCSS, node-sass)
• Algolia
• Cypress
• Mailgun
• Mockaroo
• Storybook
• Twilio

Octave lists Contacts, Offices, Projects and Past Projects, and provides an expanded editing interface for admins. Using Vulcan’s hooks and callbacks, related records are transformed upon editing the original record. Brill.

How to Install

Prerequisites

Have these tools installed first:

• Meteor
• Node.js
• npm

Installation Steps

1. Clone my fork of Vulcan.
2. Check out branch octave.
3. As per Vulcan’s Two-Repo Install, export METEOR_PACKAGE_DIRS="/[YOUR_PATH_TO]/Vulcan/packages".
4. Clone this Octave repo, then cd into its directory.
5. Rename sample_settings.json to settings.json.
6. Run the command npm install.
7. Run the script that is available for public testing, npm run start-public-testing.
8. When this command finishes after a few minutes, launch Octave by visiting http://localhost:4004 in your browser.
9. You can Sign In using “public” and “testing”. Or sign up with the username, email, and password of your choosing. (See Note.)
10. That’s it. You’re in!

Note

The sign-up email that you enter will not be used, so it can be valid or a dummy value. When you first sign up, you will have limited permissions. There are secrets that are not on Github — for access to all objects, for access to the real Octave database, for Twilio phone number validation and formatting, for full Algolia search, etc. There is an alternative method of installation to get it all.

For greater access, DM me.