# jsonql-V1

**Repository Path**: to1source/jsonql-v1

## Basic Information

- **Project Name**: jsonql-V1
- **Description**: This is now archived jsonql V.1

V.2 will be in a new repo 
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: http://jsonql.org
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2018-07-28
- **Last Updated**: 2022-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](docs/assets/jsonql-logo.png)

> What is JSON:QL? JSON Query Load :)

**IMPORTANT NOTE: This repo is currently under heavy development and many of the existing module will get transfer to our new `@jsonql` npm namespace
Please check out website [jsonql.org](http://jsonql.js.org) for update to date information**


# jsonql tools

This is a collection of JSONql tools starting with jsonql-client and jsonql-koa

## What is jsonql

This is not a replacement of REST or GraphQL, instead we are focus on the `last one mile`.

The communication protocol is based on [JSON API](https://jsonapi.org/).

It's intend for communication between different devices or services.

And the main goal is to write the resolver (on server side) once, and the
client doesn't need any code written and it should work.

It's like this

```
  client <--> contract <--> server
```

## Query, Mutation, Auth

There are only three types of calls. `query`, `mutation` and `auth`

For more information please check one of our following available modules


- [jsonql-koa](https://www.npmjs.com/package/jsonql-koa) json:ql Koa middleware <br />[![NPM](https://nodei.co/npm/jsonql-koa.png?compact=true)](https://npmjs.org/package/jsonql-koa)
- [jsonql-client](https://www.npmjs.com/package/jsonql-client) json:ql Javascript client using Superagent <br />[![NPM](https://nodei.co/npm/jsonql-client.png?compact=true)](https://npmjs.org/package/jsonql-client)
- [jsonql-node-client](https://www.npmjs.com/package/jsonql-node-client) json:ql Node.js client <br />[![NPM](https://nodei.co/npm/jsonql-node-client.png?compact=true)](https://npmjs.org/package/jsonql-node-client)
- [jsonql-contract](https://www.npmjs.com/package/jsonql-contract) json:ql command line util that creates the contract.json <br />[![NPM](https://nodei.co/npm/jsonql-contract.png?compact=true)](https://npmjs.org/package/jsonql-contract)
- [jsonql-constants](https://www.npmjs.com/package/jsonql-constants) json:ql constants for development purpose <br />[![NPM](https://nodei.co/npm/jsonql-constants.png?compact=true)](https://npmjs.org/package/jsonql-constants)
- [jsonql-ws-server](https://www.npmjs.com/package/jsonql-ws-server) json:ql Web Socket Server support `ws` and `socket.io` <br />[![NPM](https://nodei.co/npm/jsonql-ws-server.png?compact=true)](https://npmjs.org/package/jsonql-ws-server)
- [jsonql-params-validator](https://www.npmjs.com/package/jsonql-params-validator) json:ql resolvers validate interface for both client and server <br />[![NPM](https://nodei.co/npm/jsonql-params-validator.png?compact=true)](https://npmjs.org/package/jsonql-params-validator)
- [jsonql-errors](https://www.npmjs.com/package/jsonql-errors) json:ql errors classes for use in all the jsonql js projects <br />[![NPM](https://nodei.co/npm/jsonql-errors.png?compact=true)](https://npmjs.org/package/jsonql-errors)

There are several more in the planning stage

- json:ql ws-client the websocket client for Browser
- json:ql rx-client - this is the new client that replace the fetch / ws client using stream
- ~~json:ql ts-koa - this is the Typescript port for the server side~~ This will replace by json:ql-deno
- json:ql ts-rx-client - the rx client using Typescript
- json:ql Go
- json:ql Dart
- json:ql ASP.NET

If you are interested in creating your implementation please do not hesitate to contact us.

## Work on this project

Please first fork this repo. Then setup your git as follow:

```sh
$ git remote add upstream git@gitee.com:to1source/jsonql.git
$ git remote -v
$ git fetch upstream
```

Once you are done coding, please PR your code for checking. Please make sure you have
written test accordingly before PR.

## Documentation (coming soon)

Full documentation at [json:ql](https://jsonql.js.org)

---

MIT

Co-Develop by [to1source LTD China](https://to1source.com) and [NEWBRAN LTD UK](https://newbran.ch)