https://github.com/kevinashworth/octave

Public version of Octave.
https://github.com/kevinashworth/octave

algolia graphql meteor mongodb reactjs twilio vulcan

Last synced: about 4 hours ago
JSON representation

Public version of Octave.

• Host: GitHub
• URL: https://github.com/kevinashworth/octave
• Owner: kevinashworth
• License: mit
• Created: 2020-07-18T00:49:23.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-02-10T23:49:11.000Z (almost 3 years ago)
• Last Synced: 2024-07-30T16:51:16.847Z (6 months ago)
• Topics: algolia, graphql, meteor, mongodb, reactjs, twilio, vulcan
• Language: JavaScript
• Homepage:
• Size: 12.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

        
# **Octave** README

## Description

**Octave** is a place to collaborate and share information.

## Technologies

**Octave** is built with:

- [Vulcan](http://vulcanjs.org/), the “full-stack React+GraphQL framework,”

built with:

  - [React](https://reactjs.org/)

  - [GraphQL](https://graphql.org/)

  - [Meteor](https://www.meteor.com/)

  - [Apollo](https://www.apollographql.com/)

  - [MongoDB](https://www.mongodb.com/)

- Bootstrap ([react-boostrap](https://react-bootstrap.github.io/),

[SCSS](https://sass-lang.com/documentation/syntax#scss), [node-sass](https://github.com/sass/node-sass))

- [Algolia](https://www.algolia.com/)

- [Cypress](https://cypress.io/)

- [Mailgun](https://www.mailgun.com/)

- [Mockaroo](https://mockaroo.com/)

- [Storybook](https://storybook.js.org/)

- [Twilio](https://www.twilio.com/)

**Octave** lists Contacts, Offices, Projects and Past Projects, and provides an

expanded editing interface for admins. Using Vulcan’s

[hooks and callbacks](https://docs.vulcanjs.org/callbacks.html), 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](https://github.com/kevinashworth/Vulcan).

2. Check out branch [`octave`](https://github.com/kevinashworth/Vulcan/tree/Octave).

3. As per Vulcan’s [Two-Repo Install](https://docs.vulcanjs.org/#Two-Repo-Install-Optional), `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  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.