mariadb-corporation / dev-example-places

A web application (with multiple API project options) that uses MariaDB!

Places

⚠️⚠️⚠️

[UNMAINTAINED]
This repository has been split up (by back-end language), moved and is currently maintained at the following locations:

• Node.js (basic)
• Python (basic)
• JDBC (Spring Data)
• R2DBC (Spring Data)

⚠️⚠️⚠️

Places is a web application backed by the power of the power, performance, and simplicity of MariaDB platform, allows you to record all of your favorite locations!

This README will walk you through the steps for getting the Places web application up and running using MariaDB. To ensure success, please follow the instructions in order.

Note: The code provided within this repository is completely open source. Please feel free to use it as you see fit.

Table of Contents

1. Requirements
2. Getting started with MariaDB and JSON
3. Getting started with the app
   1. Get the code
   2. Create the schema
   3. Anatomy of the app
   4. Build and run the app
4. JSON Data Models
5. Support and Contribution
6. License

Requirements

This sample application, no matter which API project you target, will requires the following to be installed/enabled on your machine:

• MariaDB Client, used to connect to MariaDB instances.

Getting started with MariaDB and JSON

Set up a MariaDB database, loaded with the data this sample needs, using the MariaDB JSON Quickstart, before continuing to the next step.

Getting started with the app

In order to run the Places application you will need to have a MariaDB instance to connect to. For more information please check out "Get Started with MariaDB".

Get the code

Download this code directly or use git (through CLI or a client) to retrieve the code using git clone:

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

Create the schema

Connect to the database using CLI or a client and execute the following:

CREATE TABLE `locations` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(100) NOT NULL DEFAULT '',
  `description` varchar(500) DEFAULT '',
  `type` char(1) NOT NULL DEFAULT '',
  `latitude` decimal(9,6) NOT NULL,
  `longitude` decimal(9,6) NOT NULL,
  `attr` longtext CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL CHECK (json_valid(`attr`)),
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Anatomy of the app

This application is made of two parts:

• Client
  • communicates with the API.
  • is a React.js project located in the client folder.
• API
  • uses a MariaDB Connector to connect to MariaDB.
  • contains multiple projects, located in the api folder.
    • Node.js
    • Python

See the README's in client and api for more information on how to get started!

Build and run the app

1. Nagivate to the client folder and execute the following CLI command before proceeding:

   $ npm install
   

2. Configure the MariaDB connection by an environmental (called .env) file within the client folder.

   $ touch .env
   

   Then add the key REACT_APP_GOOGLE_API_KEY and a Google Maps API Key.

   REACT_APP_GOOGLE_API_KEY=<google_api_key_here>
   

   Note: The REACT_APP_GOOGLE_API_KEY environmental variable is used here.

3. Pick an API project and follow the instructions of the README to build and run the API project.

4. Navigate to the client folder and execute the following CLI command to start the React.js application.

   $ npm start

5. Open a browser window and navigate to http://localhost:3000.

JSON Data Models

Below are samples of the data model per Location Type.

Attraction

{
   "category":"Landmark",
   "lastVisitDate":"11/5/2019"
}

Location

{
   "details":{
      "foodType":"Pizza",
      "menu":"www.giodanos.com/menu"
   },
   "favorites":[
      {
         "description":"Classic Chicago",
         "price":24.99
      },
      {
         "description":"Salad",
         "price":9.99
      }
   ]
}

Sports Venue

{
   "details":{
      "yearOpened":1994,
      "capacity":23500
   },
   "events":[
      {
         "date":"10/18/2019",
         "description":"Bulls vs Celtics"
      },
      {
         "date":"10/21/2019",
         "description":"Bulls vs Lakers"
      },
      {
         "date":"11/5/2019",
         "description":"Bulls vs Bucks"
      },
      {
         "date":"11/5/2019",
         "description":"Blackhawks vs Blues"
      }
   ]
}

Support and Contribution

Please feel free to submit PR's, issues or requests to this project project or projects within the official MariaDB Corporation GitHub organization.

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:

• [e-mail]
• MariaDB Twitter

License