Skip to content

Commit

Permalink
Update public-testing
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinashworth committed Jan 30, 2021
1 parent 34f98a7 commit 542030d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 39 deletions.
52 changes: 14 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,44 +42,20 @@ Have these tools installed first:
### Installation Steps

1. Clone [my fork of Vulcan](https://github.com/kevinashworth/Vulcan).
Be sure to check out branch [`octave`](https://github.com/kevinashworth/Vulcan/tree/Octave).
(There is no need to do more than clone this repo on the correct branch.)
2. Clone this here **Octave** repo, then `cd` into its directory.
3. Rename `sample_settings.json` to `settings.json`.
4. Run the command `npm install`.<sup>1</sup>
5. As per Vulcan’s [Two-Repo Install](https://docs.vulcanjs.org/#Two-Repo-Install-Optional),
start **Octave** 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 **Octave** by visiting
<http://localhost:4004> in your browser.
7. Click Sign Up and enter the username, email, and password of your choosing.<sup>2</sup>
8. That’s it. You’re in!
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 <http://localhost:4004> in your browser.
9. Click Sign Up and enter the username, email, and password of your choosing.
10. That’s it. You’re in!

## Note

There are secrets that are not on Github — for the real **Octave** database, for Twilio
phone number validation and formatting, for full Algolia search. There is an alternative
method of setting up to get it all. DM me.

---

## Footnotes

<sup>1</sup> Near the end of this process, you will see messages about contacts,
offices, etc. This is seed data being randomly generated via Mockaroo.
If you like, you can re-run this seeding process at any time.
To replace old seed data with new seed data:

- run `meteor reset`, which will clear out the existing Mongo data
- delete the `mockaroo/generated` and `packages/Octave/lib/server/seeds/generated`
directories
- run `npm run prepare`

The presence of new data will trigger a re-seeding of the database on
the next **Octave** launch

<sup>2</sup> 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 a menu item after signing
in the first time, despite the message that ‘This will just take a moment.’ On
subsequent sign-ins, this message will only appear momentarily.
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 setting up to get it all. DM me.
2 changes: 1 addition & 1 deletion scripts/start-public-testing.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#!/bin/sh

MONGO_URL='mongodb+srv://read-only-testing-account:valid\during\february\[email protected]/Triad?retryWrites=true&w=majority' meteor --port 4004 --settings settings-triad.json
MONGO_URL='mongodb+srv://read-only-testing-account:valid-during-february-[email protected]/Triad?retryWrites=true&w=majority' meteor --port 4004 --settings settings-public-testing.json

0 comments on commit 542030d

Please sign in to comment.