Nexus.js

Blue Brain Project | Nexus | Nexus API Docs | Sandbox

Examples | Packages | Development | License

Javascript tools to make developing on top of Blue Brain Nexus easier.

Packages

`@bbp/nexus-sdk`

An abstracted sdk layer over Blue Brain Nexus to make developing clients and services more simple.

npm | Readme

`@bbp/react-nexus`

A set of react tools to allow an easier and faster integration with Nexus.

npm | Readme

The core of nexus-sdk, this library allows to control the request/response flow by chaining "middlewares". It uses the Observable pattern which allows to contain the request/response logic into 1 function called "links".

npm | Readme

How is the repo structured?

This repo is managed as a monorepo using lerna that is composed of multiple npm packages.

Development

Make sure you perform the make actions in the repository root directory!

Using Docker

If you don't have Node.js installed on your machine, you can run a "docker shell" with make dshell from which you'll have a fully working Node.js environment. Make sure you have already installed both Docker Engine and Docker Compose.

Do things

Install: make install
Build: make build
Test: make test
Lint: make lint

License

Apache License, Version 2.0

Funding & Acknowledgment

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.