socketcluster / sc-crud-sample Goto Github PK

Sample real-time CRUD inventory tracking app built with SocketCluster

JavaScript 96.39% HTML 3.61%

rethinkdb socketcluster polymer real-time realtime rest crud

sc-crud-sample's Introduction

sc-crud-sample

Scroll to the bottom for installation instructions.

A sample inventory tracking realtime single page app built with SocketCluster (http://socketcluster.io/), VueJS and RethinkDB. It demonstrates a way of building realtime apps.

All code for the server-side worker logic is linked from worker.js - It's mostly generic so feel free to reuse/modify for your own app or you can use this app as a base to build yours if starting from scratch.

Aside from SocketCluster, VueJS and RethinkDB, this sample app uses the following modules:

sc-collection (https://github.com/SocketCluster/sc-collection - npm install sc-collection)
sc-model (https://github.com/SocketCluster/sc-model - npm install sc-model)
sc-crud-rethink (https://github.com/SocketCluster/sc-crud-rethink - npm install sc-crud-rethink)

This sample app aims to demonstrate all the cutting edge features that one might want when building a realtime single page app including:

Authentication (via JWT tokens)
Access control using backend middleware
Reactive data binding
Realtime REST-like interface
Pagination with realtime updates

Keep in mind that this app is optimized for cutting-edgeness, not for backwards compatibility with older browsers.

To make the most of this demo, you should open the web app in two different tabs/windows/browsers and make updates to the data in realtime.

Installation

To setup and run this sample:

Make sure you have Git installed (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
Make sure you have Node.js installed (http://nodejs.org/)
Make sure you have RethinkDB installed (https://www.rethinkdb.com/)
Run git clone https://github.com/SocketCluster/sc-crud-sample.git
Run cd sc-crud-sample (to navigate to the sc-crud-sample/ directory)
Run npm install (to install back end modules)
Run cd public && npm install && cd .. (to install front end modules inside the public/ directory)
In a different terminal (or in the background), run sudo rethinkdb (make sure RethinkDB stays running)
Run node server (to launch the server)
In your browser, go to http://localhost:8000/

sc-crud-sample's People

Contributors

Stargazers

Watchers

sc-crud-sample's Issues

Safari returns a blank side on localhost

Hello,

Everthink works excellent in Chrome but unfortunately safari returns a white page while loading localhost.

Make realtime-rest.js a real module

realtime-rest.js looks very nice and can be useful for many real project if it was a real module.

How to make this use OAuth with Github

Thank you for the sample.

Currently the user 'bob' is hardcoded inside the code. Instead, if I want to make users "signup" with github or similar oAuth providers, how to make it happen? Which parts need to be changed?

Parsing data from socketcluster to express.

Refresh the JWT token from time to time so that it doesn't expire while user is online

Right now it expires after a while even if user is active.

worker repeatedly crashing (?) / respwaning

Fresh installation. After logging in (with default populated 'bob' username and password), whenever we go into the any of the listed categories, the console is populated with so many errors (Screenshot below), as well the server is dumping below errors

1469169722225 - Origin: Worker (PID 9544)
   [Error] TypeError: Cannot read property 'category' of null
    at crudOptions.schema.Product.views.categoryView.transform (e:\Codebase\sc-sample-inventory\worker.js:65:78)
    at module.exports.constructTransformedRethinkQuery (e:\Codebase\sc-sample-inventory\node_modules\sc-crud-rethink\query-transformer.js:24:20)
    at SCCRUDRethink.read (e:\Codebase\sc-sample-inventory\node_modules\sc-crud-rethink\index.js:308:26)
    at Emitter.<anonymous> (e:\Codebase\sc-sample-inventory\node_modules\sc-crud-rethink\index.js:641:10)
    at Emitter.emit (e:\Codebase\sc-sample-inventory\node_modules\component-emitter\index.js:131:20)
    at Emitter.SCEmitter.emit (e:\Codebase\sc-sample-inventory\node_modules\sc-emitter\index.js:28:26)
    at e:\Codebase\sc-sample-inventory\node_modules\socketcluster-server\scsocket.js:113:44
    at e:\Codebase\sc-sample-inventory\node_modules\socketcluster-server\scserver.js:666:11
    at e:\Codebase\sc-sample-inventory\node_modules\socketcluster-server\node_modules\async\lib\async.js:52:16
    at e:\Codebase\sc-sample-inventory\node_modules\socketcluster-server\node_modules\async\lib\async.js:269:32
    at e:\Codebase\sc-sample-inventory\node_modules\socketcluster-server\node_modules\async\lib\async.js:44:16
    at e:\Codebase\sc-sample-inventory\node_modules\sc-crud-rethink\filter.js:49:13
    at mustBeLoggedIn (e:\Codebase\sc-sample-inventory\worker.js:93:7)
    at Object.<anonymous> (e:\Codebase\sc-sample-inventory\node_modules\sc-crud-rethink\filter.js:40:9)
    at e:\Codebase\sc-sample-inventory\node_modules\socketcluster-server\node_modules\async\lib\async.js:1165:24
    at iterate (e:\Codebase\sc-sample-inventory\node_modules\socketcluster-server\node_modules\async\lib\async.js:262:13)
1469169722290 - Worker 0 exited - Exit code: 1
   >> Worker PID: 13260
Creating a pool connected to 192.168.99.100:28015
1469169722936 - Worker 0 was respawned

socketcluster / sc-crud-sample Goto Github PK

sc-crud-sample's Introduction

sc-crud-sample

Installation

sc-crud-sample's People

Contributors

Stargazers

Watchers

Forkers

sc-crud-sample's Issues

Safari returns a blank side on localhost

Make realtime-rest.js a real module

How to make this use OAuth with Github

Parsing data from socketcluster to express.

Refresh the JWT token from time to time so that it doesn't expire while user is online

worker repeatedly crashing (?) / respwaning

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent