Flights

Flights is a web application, backed by the power of MariaDB ColumnStore, allows you to analyze millions flight records from the United States Department of Transportation in real time without needing to add any indexes!

This application is made of two parts:

• Client
  • web UI that communicates with REST endpoints available through an API app (see below).
  • is a React.js project located in the client folder.
• API
  • uses the MariaDB Node.js Connector to connect to MariaDB.
  • is a Node.js project located in the api folder.

This README will walk you through the steps for getting the Flights web application up and running using MariaDB.

Table of Contents

1. Requirements
2. Getting started with MariaDB ColumnStore
3. Get the code
4. Configure, build and run the app
   1. Configure
   2. Build and run the Node.js API app
   3. Build and run the Client app
5. Support and contribution
6. License

Requirements

This sample application requires the following to be installed/enabled on your machine:

• Node.js (v. 12+)
• NPM (v. 6+)
• MariaDB command-line client (optional), used to connect to MariaDB database instances.

1.) Getting Started with MariaDB ColumnStore

MariaDB is a community-developed, commercially supported relational database management system, and the database you'll be using for this application.

This sample uses MariaDB ColumnStore. The quickest way to get started is by using the MariaDB ColumnStore Quickstart Guide, which will walk you through the process of getting a MariaDB database instance (via Docker container) up, running and loaded with the data necessary for this sample app.

TL;DR - Check out the MariaDB ColumnStore Quickstart before proceeding to the next step.

2.) Get the code

First, use git (through CLI or a client) to retrieve the code using git clone:

$ git clone https://github.com/mariadb-developers/flights-app-nodejs.git

Next, because this repo uses a git submodule, you will need to pull the client application using:

$ git submodule update --init --recursive

3.) Configure, Build and Run the App

Important: Before proceeding you'll need to have a MariaDB ColumnStore instance preloaded with flight data for this application to use. You can find more information here.

This application is made of two parts:

• Client
  • web UI that communicates with REST endpoints available through an API app (see below).
  • is a React.js project located in the client folder.
• API
  • uses the MariaDB Node.js Connector to connect to MariaDB.
  • is a Node.js project located in the api folder.

a.) Configure the app

Configure the MariaDB connection by adding an .env file to the Node.js project. Add the .env file here (the api folder).

Example implementation:

DB_HOST=<host_address>
DB_PORT=<port_number>
DB_USER=<username>
DB_PASS=<password>
DB_NAME=flights

Configuring db.js

The environmental variables from .env are used within the db.js for the MariaDB Node.js Connector configuration pool settings:

var mariadb = require('mariadb');
require('dotenv').config();

const pool = mariadb.createPool({
  host: process.env.DB_HOST, 
  user: process.env.DB_USER, 
  password: process.env.DB_PASS,
  port: process.env.DB_PORT,
  database: process.env.DB_NAME,
  multipleStatements: true
});

b.) Build and run the Node.js API app

To start and run the API application you need to execute the following commands within the api root folder.

1. Install the Node.js packages (dependendies) for the app.

$ npm install

2. Run the the app, which will expose API endpoints via http://localhost:8080.

$ npm start

c.) Build and run the UI (Client) app

Once the API project is running you can now communicate with the exposed endpoints directly (via HTTP requests) or with the application UI, which is contained with the client folder of this repo.

To start the client application follow the instructions here.

Support and Contribution

Please feel free to submit PR's, issues or requests to this project project directly.

If you have any other questions, comments, or looking for more information on MariaDB please check out:

• MariaDB Developer Hub
• MariaDB Community Slack

Or reach out to us diretly via:

• [email protected]
• MariaDB Twitter

License