An open API service indexing awesome lists of open source software.

https://github.com/rockset/rockset-js


https://github.com/rockset/rockset-js

client javascript

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

rockset-js
============

The Official Home for all of Rockset's JS/TS Developer Tools

**Note: The Rockset CLI and VSCode extension are currently in a beta release. Please report any bugs to Rockset Customer Support**

![Build|Lint|Test](https://github.com/rockset/rockset-js/workflows/Build%7CLint%7CTest/badge.svg)
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
[![Strict TypeScript Checked](https://badgen.net/badge/TS/Strict "Strict TypeScript Checked")](https://www.typescriptlang.org)

This repo is managed by [lerna](https://github.com/lerna/lerna) and [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).

## Live Demo

You can view a live demo that covers all of these tools [here](https://www.youtube.com/watch?v=WhRueFicCUg).

## Packages

All Lerna packages are in [packages](./packages) directory. Each individual project has detailed documentation about its usage.

* [Rockset JS SDK](./packages/client)
* [Rockset CLI](./packages/cli)
* [Rockset VSCode Plugin](./packages/rscode)
* [Rockset Developer UI](./packages/dev-server)

## Contributing

To get started, please ensure that you are on Node.js 12.x.

```bash
# install dependencies
yarn

# Watch all files for changes
yarn start

# Build production versions
yarn run build
```

## Publishing

The publishing of all of the above projects is handled automatically through Github Actions. Simply run the following in the repository root, and then monitor the deployment in Github Actions.

```
./release
```

The only exception to the above is the VSCode plugin, which currently is manually deployed.