Memri / Getting Started / Quick Start

Quick Start

Set up the pod

Here is how to host a Pod on your own hardware:

Docker creates an independent environment with all the dependencies you need to run the Pod in an easy way.

  1. Install Docker & Docker Compose

  2. Clone the repository and build the container:

$ git clone -b prod https://gitlab.memri.io/memri/pod.git
$ cd pod
$ docker-compose build
$ docker-compose up

This is the preferred way if you want to make changes or play around with Pod itself.

Go to Pod documentation for updated instructions on local build/run.

You can skip this step if you want to run the Client app without a Pod.

Set up a Client

You can use the web-client or try the iOS/macOS app through Xcode:

You’ll need Npm for easy installation.

Clone the browser-application repository, install and start:

$ git clone https://gitlab.memri.io/memri/browser-application.git
$ cd browser-application
$ npm install

To run the client:

$ npm run start

You’ll need Xcode & macOS >= v10.13.6

  1. Clone the iOS application repository and navigate into the folder:
$ git clone -b prod https://gitlab.memri.io/memri/ios-application.git
$ cd ios-application
  1. Open Xcode and select the project. In the run destination selector you can either choose a simulator, or connect your iPhone to you Mac via USB or WiFi. Press the play button to run the application.

    The first build probably will take some time (luckily, it is cached).

    If you have an Apple developer id, you can login via preferences -> accounts, and you are able to run the app as is. If you don’t, you need to change the app bundle ID. You can use polis.memri.dev, but almost anything other than polis.memri will do (because it has been reserved for this app). If you want to learn more about bundle ids, check this source.

You can also request access to the weekly release of the iOS app in Testflight.

Connect

To set up your connection with the pod, the only thing you need to do is set the right IP address: localhost:3030 when you are running in a simulator, and <local-laptop-IP>:3030 when your device is connected over USB or over WiFi.

If you want to run a Client without a Pod, you’ll see an option for that on the welcome screen.



Now that you have a front and back end, it’s time to work with some data!

Try running an importer!

The email importer plugin, of the python plugins family, fetches your emails and accounts over IMAP, it uses the python built-in imap client and some convenience functions for easier usage, batching and importing to the pod.

Customize your interface!

The client uses CVU language (c-view or Cascading Views) for defining the interfaces in the app. You can use our CVU Editor to customize any interface you like or create your own! It is an easy to use language that combines the best of HTML and CSS. Check out the Customizing the UI tutorials to learn more.

Try running an indexer!

When we run an indexer we have four steps. 1) Get the indexer and indexer run based on the run uid. 2) run the indexer 3) populate the graph with the new information. Try it out in the Running your own indexer guide in the Python Plugins documentation.


We are an open community! Get involved!

Learn more about contributing to Memri