Skip to content
Simple, powerful online communities.
Branch: alpha
Clone or download
brianlovin Merge pull request #4879 from withspectrum/depfu/update/vulcan/yarn/s…
…topword-0.1.17

[vulcan] Update stopword: 0.1.15 → 0.1.17 (minor)
Latest commit e02fd87 Mar 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Fix yaml spacing, rename some things Mar 8, 2019
.github Remove more mobile references Dec 11, 2018
admin Move keycodes.js to src/helpers Jan 11, 2019
analytics
api Merge pull request #4860 from withspectrum/depfu/update/api/yarn/helm… Mar 17, 2019
athena Fix athena deploys Mar 9, 2019
built-email-templates
chronos Update imgix-core-js to version 1.2.1 Mar 10, 2019
cypress
desktop Update electron-builder to version 20.39.0 Mar 12, 2019
docs
email-template-scripts Fix repeating heading in digest emails Mar 1, 2019
email-templates
flow-typed
hermes Update aws-sdk to version 2.409.0 Feb 23, 2019
hyperion Increase hyperion rate limits by a nudge Feb 25, 2019
mercury
public Use compress image Dec 6, 2018
scripts Merge pull request #4687 from withspectrum/run-rm-after-deploy Feb 21, 2019
shared Fix media messages Mar 13, 2019
src Render "App" badge for bot posts Mar 14, 2019
vulcan Update stopword to version 0.1.17 Mar 18, 2019
.babelrc Fix shared queries Jan 29, 2018
.eslintignore
.eslintrc.js
.flowconfig Fix renderer imports Feb 25, 2019
.gitignore
.npmignore
.prettierignore Dont wrap event type string May 11, 2018
.prettierrc Use a .prettierrc to allow editors to pick up Prettier config. Apr 21, 2018
LICENSE
README.md Add project board to readme Mar 4, 2019
backpack.config.js Switch to debug in backpack.config.js Mar 19, 2018
config-overrides.js add log to hyperion build Dec 6, 2018
cypress.json Add configs to cypress and circleci Apr 17, 2018
jest.config.js
now-secrets.example.json Remove payments related code from client Sep 27, 2018
now.json Fix missing bracket in now json Dec 18, 2018
package.json
robots.txt Block Google and other search engines from alpha.spectrum.chat Mar 10, 2018
rules-alpha.json
rules.json Cadmus -> Hyperion Dec 4, 2017
spectrum-tmuxp.yaml Rename Iris to API Mar 28, 2018
upload.svg
yarn.lock

README.md

Spectrum

Simple, powerful online communities.

This is the main monorepo codebase of Spectrum. Every single line of code that's not packaged into a reusable library is in this repository.

What is Spectrum?

Vision

It is difficult to grow, manage and measure the impact of online communities. Community owners need modern, chat-based communities but are running into scaling issues when their community grows beyond a few hundred members. It becomes hard to keep track of who's who, know what conversations are happening, and ensure that the community is staying healthy and productive.

Spectrum aims to be the best platform to build any kind of community online by combining the best of forums and real-time chat apps. With best-in-class moderation tooling, a single platform for all your communities, threaded conversations by default, community health monitoring, and much more to come we think that we will be able to help more people start and grow the best online communities.

"[Spectrum] will take the place that Reddit used to have a long time ago for communities (especially tech) to freely share ideas and interact. Except realtime and trolling-free."

- Guillermo Rauch (@rauchg)

Status

Spectrum has been in full-time development since March 2017 and is part of GitHub since November 2018. See our current priorities and what we are working on in the main project board.

Docs

Contributing

We heartily welcome any and all contributions that match our engineering standards!

That being said, this codebase isn't your typical open source project because it's not a library or package with a limited scope—it's our entire product.

Ground Rules

Contributions and discussion guidelines

All conversations and communities on Spectrum agree to our underlying code of conduct. This code of conduct also applies to all conversations that happen within our contributor community here on GitHub. We expect discussions in issues and pull requests to stay positive, productive, and respectful. Remember: there are real people on the other side of that screen!

Reporting a bug or discussing a feature idea

If you found a technical bug on Spectrum or have ideas for features we should implement, the issue tracker is the best place to share your ideas. Make sure to follow the issue template and you should be golden! (click here to open a new issue)

Fixing a bug or implementing a new feature

If you find a bug on Spectrum and open a PR that fixes it we'll review it as soon as possible to ensure it matches our engineering standards.

If you want to implement a new feature, open an issue first to discuss what it'd look like and to ensure it fits in our roadmap and plans for the app (see the main project board for planned and currently ongoing work).

If you want to contribute but are unsure to start, we have a "good first issue" label which is applied to newcomer-friendly issues. Take a look at the full list of good first issues and pick something you like! There is also an "open" channel in the Spectrum community on Spectrum (how meta), if you run into troubles while trying to contribute that is the best place to talk to us.

Want to fix a bug or implement an agreed-upon feature? Great, jump to the local setup instructions!

Codebase

Technologies

With the ground rules out of the way, let's talk about the coarse architecture of this mono repo:

  • Full-stack JavaScript: We use Node.js to power our servers, and React to power our frontend apps. Almost all of the code you'll touch in this codebase will be JavaScript.
  • Background Jobs: We leverage background jobs (powered by bull and Redis) a lot. These jobs are handled by a handful of small worker servers, each with its own purpose.

Here is a list of all the big technologies we use:

  • RethinkDB: Data storage
  • Redis: Background jobs and caching
  • GraphQL: API, powered by the entire Apollo toolchain
  • Flowtype: Type-safe JavaScript
  • PassportJS: Authentication
  • React: Frontend React app

Folder structure

spectrum/
├── api        # API server
├── athena     # Worker server (notifications and general processing)
├── chronos    # Worker server (cron jobs)
├── desktop    # desktop apps (build with electron)
├── docs
├── email-templates
├── hermes     # Worker server (email sending)
├── hyperion   # Server rendering server
├── mercury    # Worker server (reputation)
├── public     # Public files used on the frontend
├── shared     # Shared JavaScript code
├── src        # Frontend SPA
└── vulcan     # Worker server (search indexing; syncing with Algolia)
Click to learn about the worker naming scheme

Naming Scheme

As you can see we follow a loose naming scheme based on ancient Greek, Roman, and philosophical figures that are somewhat related to what our servers do:

  • Hyperion: (/haɪˈpɪəriən/) is one of the twelve Titan children of Gaia and Uranus.
  • Athena (/əˈθiːnə/) is the goddess of wisdom, craft, and war.
  • Hermes (/ˈhɜːrmiːz/) is the messenger god, moving between the worlds of the mortal and the divine.
  • Chronos (/ˈkroʊnɒs/) is the personification of Time in pre-Socratic philosophy
  • Mercury (/ˈmɜːrkjʊri/) is the patron god of financial gain, commerce, eloquence (and thus poetry), messages/communication (including divination), travelers, boundaries, luck, trickery and thieves

Code Style

We run Prettier on-commit, which means you can write code in whatever style you want and it will be automatically formatted according to the common style when you run git commit. We also have ESLint setup, although we've disabled all stylistic rules since Prettier takes care of those.

Rules
  • All new .js files must be flow typed: Since we only introduced Flowtype after we finished building the first version of Spectrum, we enforce in CI that all new files added to the codebase are typed. (if you've never used Flowtype before that's totally fine, just write your code in plain JS and let us know in the PR body, we can take care of it for you)
  • No console.logs in any file: We use the debug module across the codebase to log debugging information in development only. Never commit a file that contains a console.log as CI will fail your build. The only exceptions are errors, which you can log, but you have to use console.error to be explicit about it

First time setup

The first step to running Spectrum locally is downloading the code by cloning the repository:

git clone git@github.com:withspectrum/spectrum.git

If you get Permission denied error using ssh refer here or use https link as a fallback.

git clone https://github.com/withspectrum/spectrum.git

Installation

Spectrum has four big installation steps:

  1. Install RethinkDB: See the RethinkDB documentation for instructions on installing it with your OS.
  2. Install Redis: See the Redis documentation for instructions on installing it with your OS.
  3. Install yarn: We use yarn to handle our JavaScript dependencies. (plain npm doesn't work due to our monorepo setup) See the yarn documentation for instructions on installing it.
  4. Install the dependencies: Because it's pretty tedious to install the dependencies for each worker individually we've created a script that goes through and runs yarn install for every worker for you: (this takes a couple minutes, so dive into the technical docs in the meantime)
node shared/install-dependencies.js

You've now finished installing everything! Let's migrate the database and you'll be ready to go 💯

Migrating the database

When you first download the code and want to run it locally you have to migrate the database and seed it with test data. First, start rethinkdb in its own terminal tab:

rethinkdb

Then, in a new tab, run these commands:

yarn run db:migrate
yarn run db:seed
# ⚠️ To empty the database (e.g. if there's faulty data) run yarn run db:drop

There's a shortcut for dropping, migrating and seeding the database too:

yarn run db:reset

The testing database used in end to end tests is managed separately. It is built, migrated, and seeded when you run:

yarn run start:api:test

To drop the testing database, go to http://localhost:8080/#tables while rethinkdb is running, and click Delete Database on the appropriate database.

Getting the secrets

While the app will run without any secrets set up, you won't be able to sign in locally. To get that set up, copy the provided example secrets file to the real location:

cp now-secrets.example.json now-secrets.json

Note: If you're an employee at Spectrum we've got a more complete list of secrets that also lets you upload images etc. in 1Password, search for "now-secrets.json" to find it.

Now you're ready to run the app locally and sign into your local instance!

Running the app locally

Background services

Whenever you want to run Spectrum locally you have to have RethinkDB and Redis running in the background. First start rethinkdb like we did to migrate the database:

rethinkdb

Then (without closing the rethinkdb tab!) open another tab and start Redis:

redis-server

Start the servers

Depending on what you're trying to work on you'll need to start different servers. Generally, all servers run in development mode by doing yarn run dev:<workername>, e.g. yarn run dev:hermes to start the email worker.

No matter what you're trying to do though, you'll want to have the API running, so start that in a background tab:

yarn run dev:api

Develop the web UI

To develop the frontend and web UI run

yarn run dev:web

Develop the desktop app

To develop the desktop app you have to have the dev web server running in the background (yarn run dev:web) and then, in another terminal tab, run:

yarn run dev:desktop

Note: If something didn't work or you ran into troubles please submit PRs to improve this doc and keep it up to date!


License

BSD 3-Clause, see the LICENSE file.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.