Skip to content
A real-time community platform.
Branch: master
Clone or download
Latest commit 88f351d Jul 23, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
art Embed (fav)icons in JS bundle. Dim favicon when disconnected. Apr 15, 2015
aws Add bazel build rules for server Jul 23, 2018
backend Add bazel support for psql integration test Jul 23, 2018
bzl Add bazel build rules for server Jul 23, 2018
ci Convert CI script to bazel Jul 23, 2018
client Add bazel build for client Jul 23, 2018
cluster Add bazel build rules for server Jul 23, 2018
containers Simplify dev db creation. Aug 17, 2015
doc Add bazel build rules for server Jul 23, 2018
heimctl Add bazel build rules for server Jul 23, 2018
heimlich Add bazel build rules for server Jul 23, 2018
proto Add bazel build rules for server Jul 23, 2018
templates Add bazel build rules for server Jul 23, 2018
vendor Prune vendor tests Jul 23, 2018
.dockerignore Add top-level Dockerfile Jul 10, 2018
.drone.yml Use drone-runner with HEIM_DONATION_URL support Dec 11, 2016
.gitignore Add bazel build rules for server Jul 23, 2018
.gitmodules Move client deps into this repo Jul 8, 2018
.travis.yml Convert CI script to bazel Jul 23, 2018
BUILD.bazel Add bazel build rules for server Jul 23, 2018
Dockerfile Add bazel build rules for server Jul 23, 2018
Gopkg.lock Migrate to golang/dep tool for vendoring Jul 7, 2018
Gopkg.toml Prune vendor tests Jul 23, 2018
LICENSE.CC-BY Document licensing more thoroughly. Apr 14, 2015
LICENSE.MIT
LICENSE.md Relicense from AGPL to MIT (#104) Jul 7, 2018
README.md Relicense from AGPL to MIT (#104) Jul 7, 2018
WORKSPACE Add bazel build for client Jul 23, 2018
docker-compose.yml Make etcd in dev mode opt-in. Jan 2, 2016
heim.yml Mock email delivery to stdout in dev mode. Dec 4, 2015

README.md

Heim is the backend and frontend of euphoria, a real-time community platform. The backend is a Go server that speaks JSON over WebSockets, persisting data to PostgreSQL. Our web client is built in React/Reflux.

Currently, heim is released in a pre-alpha state. Please be advised that new development is currently being prioritized over stability. We're releasing in this form because we want to open up our codebase and development progress. We will make breaking changes to the protocol, and will be slow to merge complex pull requests while we get our core building blocks in place.

Build Status GoDoc

Getting started

  1. Install git, docker, and docker-compose.

  2. Ensure dependencies are fetched: run git submodule update --init in this repo directory.

Running a server

  1. Build the client static files: docker-compose run frontend.

  2. Init your db: docker-compose run upgradedb sql-migrate up.

  3. Start the server: docker-compose up backend.

Heim is now running on port 8080. \o/

Developing the client (connected to euphoria.io)

  1. Launch the standalone static server and build watcher:
    docker-compose run --service-ports frontend gulp develop

  2. To connect to &test on euphoria.io using your local client, open: http://localhost:8080/room/test/#connect=https://euphoria.io

Running tests

Backend

docker-compose run backend go test -v euphoria.io/heim/...

Note: some tests require a database. See the CI automation script for more context.

Frontend

docker-compose run frontend npm test

Discussion

Questions? Feedback? Ideas? Come join us in &heim or email hi@euphoria.io.

Licensing

Software code is distributed under the terms of the MIT license.

Art and documentation are distributed under the terms of the CC-BY 4.0 license.

See LICENSE.md for licensing details.

You can’t perform that action at this time.