javaderg / rift

Rift

Rift is an open source communications facilitation framework built primarily in Elixir, Rust, and Node.js, and using MongoDB (migrating to ScyllaDB). Its goal is to reintroduce the way we communicate; not by changing the method by which we do so, but by centralizing the methods of communication into a single framework, which can then be used either with our React frontend which we will ship it with by default, or with a custom client built frontend designed for the usecase at hand.

---

Prerequisites

Make sure you have Node, npm, Docker, and MongoDB installed and running on the local network.

• To install and run MongoDB via Docker: docker run -p 27017:27017 --name MongoDB -d mongo:latest && docker start MongoDB

  *Note: Linux users might need to prepend sudo before both instances of docker or use root privileges, and Windows users might require an administrative PowerShell.

Getting Started

To clone the repository, run git clone https://github.com/Vor-Tech/Rift

Installing

To install Rift and its default client, cd Rift/Frontend && npm install && cd ../Backend && npm install && cd .., then, open two separate terminals. In both terminals, make sure you are in the Rift directory (located wherever you ran git clone). Then, in the first terminal, run node Backend/api/v1/index.js and in the second terminal, run cd Frontend && npm start

In first terminal:

cd Frontend
npm install
npm start

In second terminal:

cd Backend/
node api/v1/index.js

You can interact with Rift "headless" by using HTTP requests through an application like Postman or Insomnia Core

Authors

• Jonathan Kurtz - xero-lib
• Roland Metivier - Chlorophytus
• Daniel Lovecraft - Technus

License

This project is licensed under a proprietary License - see the LICENSE file for details

Acknowledgments

In progress