Rebar
Multi-tenant SaaS boilerplate + examples for universal web application with React, Material-UI, Relay, GraphQL, JWT, Node.js, C* DB - Cassandra/Elassandra/Scylla.
Technology stack
Client
| Technology | Description |
|---|---|
| found | Extensible route-based routing for React applications. |
| found-relay | Relay integration for Found. |
| GraphQL | A query language for describing the capabilities and requirements of data models for client‐server applications. |
| JSS | JSS is a more powerful abstraction over CSS. It uses JavaScript as a language to describe styles in a declarative and maintainable way. |
| Material UI | Library for implementing Material Design in React. All user interface in this kit is built predominantly using Material UI components. |
| mdi-material-ui | This module provides Material-UI components for all Material Design Icons. |
| React | The best library for building modern browser-based and mobile UIs. |
| React Helmet | Reusable React component will manage all of your changes to the document head with support for document title, meta, link, script, and base tags. |
| Relay | A Javascript framework for building data-driven react applications. |
Database Server
| Technology | Description |
|---|---|
| Cassandra | The right choice when you need scalability and high availability without compromising performance. Linear scalability and proven fault-tolerance on commodity hardware or cloud infrastructure make it the perfect platform for mission-critical data. Cassandra's support for replicating across multiple datacenters is best-in-class, providing lower latency for your users and the peace of mind of knowing that you can survive regional outages. |
| Elassandra | Elassandra Combines Cassandra And Elasticsearch In A Single Powerful Integrated Solution. |
| Scylla | The Real-Time Big Data Database. Scale-up performance of 1,000,000 IOPS per node, scale-out to hundreds of nodes and 99% latency of <1 msec. |
Web Server
| Technology | Description |
|---|---|
| bcryptjs | Optimized bcrypt in JavaScript with zero dependencies. Compatible to the C++ bcrypt binding on node.js and also working in the browser. |
| Data Loader | Generic utility to be used as part of your application's data fetching layer to provide a consistent API over various backends and reduce requests to those backends via batching and caching. |
| Express | Fast, unopinionated, minimalist web framework for Node.js. |
| express-cassandra | Cassandra ORM/ODM/OGM for Node.js with optional support for Elassandra & JanusGraph. |
| Express GraphQL | A Node.js express library that allows the creation of GraphQL servers. |
| JWT | JSON Web Tokens is an industry standard RFC 7519 method for representing claims securely between two parties. |
| nested-error-stacks | With this module, you can wrap a caught exception with extra context for better debugging. |
| Node.js | Event-driven, non-blocking I/O runtime based on JavaScript that is lightweight and efficient. |
| Winston | A logger for just about everything. |
Development tools
| Technology | Description |
|---|---|
| Babel | Transpiles ESX to ESX and performs relay transformations. |
| concurrently | Run multiple commands concurrently. |
| documentation | The documentation system for modern JavaScript. |
| ESLint | A fully pluggable tool for identifying and reporting on patterns in JavaScript. |
| Flow | Static type checker, designed to find type errors in JavaScript programs. |
| Husky | Git hooks for eslint and prettier. |
| Jest | A delightful JavaScript Testing Framework with a focus on simplicity. |
| LocalTunnel | Expose yourself to the world. |
| Prettier | Code formatter for javaScript. |
| Puppeteer | Headless Chrome Node API . |
| Webpack | Bundles npm packages, application Java Script, CSS, images, etc. into bundles. |
Development Setup
Prerequisites
The setup is for OS X only:
- watchman: install using
brew install watchman. - Node.js: minimum version as specified in
package.json. - yarn: install using
npm install -g yarn. - cqlsh: optionally installed locally.
Recommended VSCode extensions
- Bracket Pair Colorizer 2.
- ESLint.
- Flow Language Support.
- GraphQL for VSCode.
- Markdown Preview Enhanced.
- Material Icon Theme.
- Path Intellisense.
- Prettier Now.
- vscode-language-todo.
Setting up Scylla in docker
Setup
docker pull scylladb/scylla:3.2.1
docker run --name scylly -d -p 9042:9042 scylladb/scylla:3.2.1
Start/Stop
docker start scylly
docker stop scylly
Troubleshooting
docker exec -it scylly scylla --version
docker exec -it scylly nodetool status
docker exec -it scylly cqlsh
docker logs scylly | tail
Cleanup
docker rm scylly
Setup on local development machine
In order to set up the project locally, perform the following steps:
| Action | Notes |
|---|---|
git clone https://github.com/MachineAcuity/rebar.git |
Clone from github. Alternatively, you can download the source and update in some different way. |
yarn |
Install node packages. |
yarn setup-local |
Set up default configuration for running the boilerplate. |
Edit .env |
Set database server / name, secrets, API keys. etc. |
yarn setup-database |
Creates Cassandra schema. |
In addition to the above, you might want to specify JWT_SECRET by modifying the .env file. This step can be skipped if you do not care about the actual security and simply want to get the project running.
Development
Running in Development Mode
In order to develop, three servers need to be started:
- Web server.
- Webpack server.
- Relay compiler (watching).
- Local tunnel.
This can be done with one command: yarn dev.
To open the web app: navigate to http://localhost:28605, or whatever IP was assigned when running yarn update-ip.
Configuring Local Tunnel
In some cases it is necessary to make your development environment publicly available under HTTPS. The service Local Tunnel allows you to easily share a Rebar project on your local development machine without messing with DNS and firewall settings. In order to use LocalTunnel, edit units/_configuration/rb-base-tools/tunnels.json. Replace the value of
"subdomain": "replace-with-your-own-domain"
with your preferred value. Please notice that LocalTunnel allocates subdomain names on a first come first serve basis, for the duration of using the service. Navigate to https://replace-with-your-own-domain.localtunnel.me.
Server Debugging
- Run
yarn deb. - Open a Chromium based browser and navigate to
about:inspect. - Click
Open dedicated DevTools for Node.
Unfortunately source maps are not available at this moment.
Documentation
Documentation can be added to code in JSDoc format and is produced by documentation. This is done because of the superior flow support. It is generated in doc/code.
Testing
Unit Testing
Examples of Jest unit tests are available in units/rb-base-test.
End to End Testing
Example of end-to-end tests suing Jest and Puppeteer are available on github in repository MachineAcuity/rebar-test-e2e.
Production Setup
In order to run rebar in production-like mode you can:
$ yarn build-deployment
...
$ export NODE_ENV=production
$ node ./deployment/units/rb-base-server/server
A production setup would include the deployment directory, with appropriate .env file, and running units/rb-base-server/server in some sort of fashion.