tudamp / crate-sample-apps

A JavaScript guestbook app with a number of different backend implementations, each using a different client library to communicate with CrateDB.

CrateDB Sample Apps

Overview

A JavaScript guestbook app with a number of different backend implementations, each using a different client library to communicate with CrateDB.

Prerequisites

You need install and run CrateDB 0.54.1 or higher before you set things up.

If you're using the Java backend, you will need 0.57.0 or higher.

You will also need to install crash (the CrateDB CLI tool) to work with CrateDB on the command line.

See the CrateDB Getting Started guide for help.

Setup

Once CrateDB instance is running, create the required schema and import the country data:

$ crash < sql/schemas.sql
$ crash -c "COPY guestbook.countries FROM '$(pwd)/sql/countries.json'"

Components

Frontend

The frontend is shared by all apps and is written in JavaScript. This frontend communicates with the backend over a REST API.

Backends

The are several implementations of the backend REST API:

• Python (using dbapi, crate-python)
• PHP (using PDO, crate-pdo)
• Java (using JDBC, pgjdbc)
• Java-Spring (using Spring Boot, Spring Data JDBC)
• Erlang (using Erlang, craterl)

Contributing

This project is community maintained, any contributions are welcome.

See the developer docs and the contribution docs for more information.

Help

Looking for more help?

• Check out our support channels