Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.54 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.54 KB

π-Base Server

A GraphQL server for querying and updating the π-base data repository

CircleCI Docker Repository on Quay

Installation

To run a server locally, git clone and cd in to the project and then

$ stack setup # to install the appropriate version of GHC
$ stack build # to build the server

Once built, you can also run stack exec -- pibase --help to view other cli options.

The server operates on a local copy of the data repository. By default, it will clone a copy from upstream - run stack exec -- pibase settings and inspect the repoPath and upstream settings to see where to and from.

Assuming everything looks good, you can run

$ stack exec -- pibase server # to start the server

and should see a message like [Info] Application starting on port 3141. You should be able to visit http://localhost:3141 in your browser and see metadata about the running server.

Running the Viewer

See the Viewer README for details about running the frontend viewer.

Questions

We aim to keep this documentation as up-to-date as possible, but if you ever have any questions, please feel free to reach out - either by email or by opening a ticket on Github.