V8 README

Description

V8 is a place to collaborate and share information.

Technologies

V8 is built with:

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

How to Install

Prerequisites

Have these tools installed first:

• Meteor
• Node
• NPM

Installation Steps

1. Clone the main Vulcan repo.
2. Clone this V8 repo, then cd into its directory.
3. Rename sample_settings.json to settings.json.
4. Run npm install.¹
5. As per Vulcan’s Two-Repo Install, start V8 with METEOR_PACKAGE_DIRS="/[YOUR_PATH_TO]/Vulcan/packages" meteor --port 4004 --settings settings.json.
6. When this command finishes after a few minutes, launch V8 by visiting http://localhost:4004 in your browser.
7. Click Sign Up and enter username, email, and password.²
8. That’s it. You’re in!

Notes

There are secrets that are not on Github — for the real V8 database, for phone number validation and formatting, for search. This publicly available version has a limited amount of seed data, and skips some functionality.

¹ Near the end of the install process, you will see messages about contacts, offices, etc. This is seed data being randomly generated via Mockaroo. You can re-run this seeding process by typing npm run prepare. To replace old seed data with new seed data, run meteor reset, which will clear out the existing Mongo data, and delete the mockaroo/generated and packages/v8/lib/server/seeds/generated directories. Then the npm command install or prepare will trigger a re-seeding of the database on the next V8 launch.

² This first user that you create will automatically become a user with admin permissions. The email that you enter will not be used, so it can be valid or a dummy value. Also, you may need to click menu items after logging in the first time, despite the message that ‘This will just take a moment.’ On subsequent logins this screen will only appear momentarily.