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

Database Server

Web Server

Development tools

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:

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.