Giter Club home page Giter Club logo

heim's Introduction

โ—“

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. Link in our dependencies repository:

    1. Clone heim-deps.
    2. ./heim-deps/deps.sh link ./path/to/heim/repo
  3. Build the client static files: docker-compose run frontend.

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

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

Heim is now running on port 8080. \o/

Discussion

Questions? Feedback? Ideas? Come join us in &heim or email [email protected].

Licensing

Most of the server is distributed under the terms of the GNU Affero General Public License 3.0.

The client 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.

heim's People

Contributors

chromakode avatar logan avatar ckingdev avatar rainbowbismuth avatar

Watchers

James Cloos avatar Step1Profit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.