https://github.com/bluebrain/nexus-js

A set of JavaScript libraries built on top of Nexus
https://github.com/bluebrain/nexus-js

isomorphic javascript nexus nodejs sdk typescript

Last synced: 6 months ago
JSON representation

A set of JavaScript libraries built on top of Nexus

• Host: GitHub
• URL: https://github.com/bluebrain/nexus-js
• Owner: BlueBrain
• License: apache-2.0
• Created: 2017-09-12T11:50:14.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T23:22:07.000Z (over 2 years ago)
• Last Synced: 2025-04-18T09:34:33.094Z (6 months ago)
• Topics: isomorphic, javascript, nexus, nodejs, sdk, typescript
• Language: TypeScript
• Homepage: https://bluebrainnexus.io
• Size: 5.85 MB
• Stars: 11
• Watchers: 18
• Forks: 4
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Authors: AUTHORS.txt

Awesome Lists containing this project

README

          


# 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`](./packages/nexus-sdk/README.md#readme)

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

[npm](https://www.npmjs.com/package/@bbp/nexus-sdk) | [Readme](./packages/nexus-sdk#readme)

### [`@bbp/react-nexus`](./packages/react-nexus/README.md#readme)

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

[npm](https://www.npmjs.com/package/@bbp/react-nexus) | [Readme](./packages/react-nexus#readme)

### [`@bbp/nexus-link`](./packages/nexus-link/README.md#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](https://www.npmjs.com/package/@bbp/nexus-link) | [Readme](./packages/nexus-link#readme)

#### How is the repo structured?

This repo is managed as a _monorepo_ using [lerna](https://github.com/lerna/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](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/).

### Do things

- Install: `make install`

- Build: `make build`

- Test: `make test`

- Lint: `make lint`

## License

[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-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.

Copyright © 2015-2023 Blue Brain Project/EPFL