Todo App with MariaDB Connector/Node.js

Clone the Repository

The Todo example application is available from the MariaDB Corporation repository on GitHub. It contains the API code in Node.js and other languages, and the React.js front-end web application that connects to the API.

To download the Todo application, clone the repository from GitHub:

$ git clone https://github.com/mariadb-corporation/dev-example-todo.git

This creates a dev-example-todo directory on your file system.

Provision Database Service

Todo requires a back-end database service using the InnoDB storage engine. The application is compatible with Single Node Transactions and Replicated Transactions topologies of MariaDB SkySQL. For the purposes of demonstration, this guide uses the Single Node Transactions topology on MariaDB SkySQL.

For additional information, see "Launch".

Create the Database Schema

Todo uses an InnoDB table to store the todo entries.

Use the MariaDB Client to connect to the database service and initialize the schema:

1. Connect to your database service.

2. Use CREATE DATABASE to create a database for the application:

   CREATE DATABASE todo;
   

3. Use CREATE TABLE to create a table to store the todo entries:

   CREATE TABLE todo.tasks (
     id INT PRIMARY KEY AUTO_INCREMENT,
     description VARCHAR(500) NOT NULL,
     completed BOOLEAN NOT NULL DEFAULT 0
   ) ENGINE = InnoDB;
   

This creates a todo.tasks table for use by the Todo application with MariaDB SkySQL as a database back-end.

Configure the Back-end Application Service

To connect to your MariaDB SkySQL database service, the application must be configured to use the appropriate credentials.

1. Create a .env file in the api/nodejs/basic directory, set the variables to the login credentials for your MariaDB SkySQL service:

   DB_HOST = example.skysql.net
   DB_USER = db_user
   DB_PASS = db_user_passwd
   DB_PORT = 5001
   DB_NAME = todo
   

2. Edit the db.js file and modify the value of the serverCert constant, so that it points to the location of the skysql_chain.pem file on your file system:

   // 2.) Retrieve the Certificate Authority chain file (wherever you placed it - notice it's just in the Node project root here)
   const serverCert = [fs.readFileSync("/path/to/skysql_chain.pem", "utf8")];
   

3. In the mariadb.createPool() configuration, confirm that the ssl property sets the ca property to the serverCert constant, so that MariaDB Connector/Node.js uses TLS with SkySQL's CA certificate:

   // Create a connection pool
   var 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,
       connectionLimit: 5,
       // 3.) Add an "ssl" property to the connection pool configuration, using the serverCert const defined above
       ssl: {
         ca: serverCert
       }
     });
   

Build the Back-end Application Service

To build the Node.js back-end application service:

$ npm install

Start the Back-end Application Service

Once you have the back-end application service configured and installed, you can start the service:

$ npm start