UNPKG

@chatie/db/README.md

Version:

3.7 kBMarkdownView Raw

1# CHATIE DB
2
3[![npm version](https://badge.fury.io/js/%40chatie%2Fdb.svg)](https://www.npmjs.com/package/@chatie/db)
4[![Build Status](https://api.travis-ci.org/Chatie/db.svg?branch=master)](https://travis-ci.org/Chatie/db)
5[![Greenkeeper badge](https://badges.greenkeeper.io/Chatie/db.svg)](https://greenkeeper.io/)
6
7RealTime Database for [Chatie Service](https://www.chatie.io)
8
9![RealTime Data](https://chatie.io/db/images/realtime-data.png)
10> Picture Credit: [What is Real-time Data?](https://www.insightdata.co.uk/news/what-is-real-time-data/)
11
12# FEATURES
13
141. RealTime Store Class for Hostie, Botie and Gitfie etc.
151. Backed by [@chatie/graphql](https://github.com/Chatie/graphql) which Powered By [GraphCool](https://www.graph.cool/).
16
17# TESTING
18
19## Generate Schemas
20
21Generate schemas from the production graphql server:
22
23```shell
24npm run generate-schemas
25```
26
27## Unit Tests
28
29Run unit tests on local server:
30
31```shell
32npm run graphcool:restart
33npm run test:unit
34```
35
36# RESOURCES
37
38## Angular Module
39
40* [Transpile your libraries to Angular Package Format](http://spektrakel.de/ng-packagr/)
41* [Angular Package Format (APF) v6.0](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview#)
42* [Juri Strumpflohner - Create and publish Angular libs like a Pro](https://www.youtube.com/watch?v=K4YMmwxGKjY)
43
44## Admin
45
46![Chart](https://heroku-blog-files.s3.amazonaws.com/posts/1479328331-Kafka%20Twitter%20Dashboard.gif)
47> https://blog.heroku.com/kafka-data-pipelines-frp-node
48
49
50## Apollo Client
51
52* [Apollo Client + TypeScript example](https://medium.com/@borekb/apollo-client-typescript-example-99febdaa18fa)
53
54# CHANGE LOG
55
56### v0.5 master (Apr 8, 2018)
57
58**Angular Injection Support.**
59
601. use [ng-packagr](https://github.com/dherges/ng-packagr) to package `@chatie/db` to follow the [Angular Package Format (APF) v6.0](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview#)
61
62### v0.4 (Apr 1, 2018)
63
64**Integrate with Angular**
65
661. use `StateSwitch` to wait `ready()` for `Store`
671. integrate with `@chatie/app` in the Browser.
68
69### v0.3 (18th, Feb, 2018)
70
71Switch to [Graph.Cool](https://www.graph.cool) Serverless solution because Wilddog sucks.
72
731. use `@chatie/graphql` module to enable graphql backend.
741. unit testing with stores: Store, HostieStore, etc.
75
76> 2018-03-17 Update: [因资金问题，“野狗”停止新用户注册](https://36kr.com/p/5124258.html)
77
78### v0.2 (15th, May, 2017)
79
80Switch to [Wilddog](https://www.wilddog.com/), because Firebase `Firebase.auth().signInWithCustomToken()` is still blocked in China by GFW.
81
82### v0.1 (15th, May, 2017)
83
84Switch to [Firebase](https://firebase.google.com/) because Ionic DB Sunset Done: `404 error` at 9th May 2017
85
861. Firebase server is not blocked in China any more.
871. Rename: from Dockie to Hostie(back).
88
89### v0.0 (Mar, 2017)
90
91Starting with Realtime Database: [Ionic DB](https://forum.ionicframework.com/t/ionic-db-shutdown/84677)
92
931. Limitation: does not support server JWT
94
95## See Also
96
97* [An enhanced GraphQL developer experience with TypeScript](https://dev-blog.apollodata.com/graphql-dx-d35bcf51c943)
98
99# AUTHOR
100
101[Huan LI](http://linkedin.com/in/zixia) \<zixia@zixia.net\>
102
103<a href="https://stackexchange.com/users/265499">
104  <img src="https://stackexchange.com/users/flair/265499.png" width="208" height="58" alt="profile for zixia on Stack Exchange, a network of free, community-driven Q&amp;A sites" title="profile for zixia on Stack Exchange, a network of free, community-driven Q&amp;A sites">
105</a>
106
107# COPYRIGHT & LICENSE
108
109* Code & Docs © 2017-2018 Huan LI \<zixia@zixia.net\>
110* Code released under the Apache-2.0 License
111* Docs released under Creative Commons

1	`# CHATIE DB`
2
3	`[![npm version](https://badge.fury.io/js/%40chatie%2Fdb.svg)](https://www.npmjs.com/package/@chatie/db)`
4	`[![Build Status](https://api.travis-ci.org/Chatie/db.svg?branch=master)](https://travis-ci.org/Chatie/db)`
5	`[![Greenkeeper badge](https://badges.greenkeeper.io/Chatie/db.svg)](https://greenkeeper.io/)`
6
7	`RealTime Database for [Chatie Service](https://www.chatie.io)`
8
9	`![RealTime Data](https://chatie.io/db/images/realtime-data.png)`
10	`> Picture Credit: [What is Real-time Data?](https://www.insightdata.co.uk/news/what-is-real-time-data/)`
11
12	`# FEATURES`
13
14	`1. RealTime Store Class for Hostie, Botie and Gitfie etc.`
15	`1. Backed by [@chatie/graphql](https://github.com/Chatie/graphql) which Powered By [GraphCool](https://www.graph.cool/).`
16
17	`# TESTING`
18
19	`## Generate Schemas`
20
21	`Generate schemas from the production graphql server:`
22
23	```shell
24	`npm run generate-schemas`
25	```
26
27	`## Unit Tests`
28
29	`Run unit tests on local server:`
30
31	```shell
32	`npm run graphcool:restart`
33	`npm run test:unit`
34	```
35
36	`# RESOURCES`
37
38	`## Angular Module`
39
40	`* [Transpile your libraries to Angular Package Format](http://spektrakel.de/ng-packagr/)`
41	`* [Angular Package Format (APF) v6.0](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview#)`
42	`* [Juri Strumpflohner - Create and publish Angular libs like a Pro](https://www.youtube.com/watch?v=K4YMmwxGKjY)`
43
44	`## Admin`
45
46	`![Chart](https://heroku-blog-files.s3.amazonaws.com/posts/1479328331-Kafka%20Twitter%20Dashboard.gif)`
47	`> https://blog.heroku.com/kafka-data-pipelines-frp-node`
48
49
50	`## Apollo Client`
51
52	`* [Apollo Client + TypeScript example](https://medium.com/@borekb/apollo-client-typescript-example-99febdaa18fa)`
53
54	`# CHANGE LOG`
55
56	`### v0.5 master (Apr 8, 2018)`
57
58	`Angular Injection Support.`
59
60	1. use [ng-packagr](https://github.com/dherges/ng-packagr) to package `@chatie/db` to follow the [Angular Package Format (APF) v6.0](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview#)
61
62	`### v0.4 (Apr 1, 2018)`
63
64	`Integrate with Angular`
65
66	1. use `StateSwitch` to wait `ready()` for `Store`
67	1. integrate with `@chatie/app` in the Browser.
68
69	`### v0.3 (18th, Feb, 2018)`
70
71	`Switch to [Graph.Cool](https://www.graph.cool) Serverless solution because Wilddog sucks.`
72
73	1. use `@chatie/graphql` module to enable graphql backend.
74	`1. unit testing with stores: Store, HostieStore, etc.`
75
76	`> 2018-03-17 Update: [因资金问题，“野狗”停止新用户注册](https://36kr.com/p/5124258.html)`
77
78	`### v0.2 (15th, May, 2017)`
79
80	Switch to [Wilddog](https://www.wilddog.com/), because Firebase `Firebase.auth().signInWithCustomToken()` is still blocked in China by GFW.
81
82	`### v0.1 (15th, May, 2017)`
83
84	Switch to [Firebase](https://firebase.google.com/) because Ionic DB Sunset Done: `404 error` at 9th May 2017
85
86	`1. Firebase server is not blocked in China any more.`
87	`1. Rename: from Dockie to Hostie(back).`
88
89	`### v0.0 (Mar, 2017)`
90
91	`Starting with Realtime Database: [Ionic DB](https://forum.ionicframework.com/t/ionic-db-shutdown/84677)`
92
93	`1. Limitation: does not support server JWT`
94
95	`## See Also`
96
97	`* [An enhanced GraphQL developer experience with TypeScript](https://dev-blog.apollodata.com/graphql-dx-d35bcf51c943)`
98
99	`# AUTHOR`
100
101	`[Huan LI](http://linkedin.com/in/zixia) \<zixia@zixia.net\>`
102
103	`<a href="https://stackexchange.com/users/265499">`
104	`<img src="https://stackexchange.com/users/flair/265499.png" width="208" height="58" alt="profile for zixia on Stack Exchange, a network of free, community-driven Q&A sites" title="profile for zixia on Stack Exchange, a network of free, community-driven Q&A sites">`
105	`</a>`
106
107	`# COPYRIGHT & LICENSE`
108
109	`* Code & Docs © 2017-2018 Huan LI \<zixia@zixia.net\>`
110	`* Code released under the Apache-2.0 License`
111	`* Docs released under Creative Commons`