mirror of https://github.com/mariadb-corporation/dev-example-places.git synced 2025-08-16 14:54:00 +00:00

Files

Rob Hedgpeth 721742f575 Initial additions

2020-04-01 17:16:52 -05:00

6.9 KiB

Raw Blame History

Places

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!

The following will walk you through the steps for getting this application up and running within minutes! This application is completely open source. Please feel free to use it and the source code as you see fit.

Overview
Requirements
Getting started
JSON Data Models
Support and Contribution
License

Overview

MariaDB Platform

MariaDB Platform integrates the former MariaDB TX (transactions) and MariaDB AX (analytics) products so developers can build modern applications by enriching transactions with real-time analytics and historical data, creating insightful experiences and compelling opportunities for customers – and for businesses, endless ways to monetize data. It’s the only enterprise open source database built for modern applications running in the cloud.

To download and deploy MariaDB check out the instructions here. You can also make use of the MariaDB image available on Docker Hub.

MariaDB SkySQL

SkySQL is the first and only database-as-a-service (DBaaS) to bring the full power of MariaDB Platform to the cloud, including its support for transactional, analytical and hybrid workloads. Built on Kubernetes, and optimized for cloud infrastructure and services, SkySQL combines ease of use and self-service with enterprise reliability and world-class support – everything needed to safely run mission-critical databases in the cloud, and with enterprise governance.

Get started with SkySQL!

Using JSON in a relational database

JSON is fast becoming the standard format for data interchange and for unstructured data, and MariaDB Platform (in fact, all MariaDB versions 10.2 and later) include a range of JSON supporting functions.

The Places application uses only a single table for all location, and uses JSON to store more specific information based on the location type.

For more information on how JSON can be used within MariaDB please check out this blog post!

Getting started

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-orders.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 AUTO_INCREMENT=19 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 (coming soon!)

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

Build and run the app

Nagivate to the client folder and execute the following CLI command before proceeding:
```
$ npm install
```

Add the a Google Maps API KEY to MapContainer.js:

export default GoogleApiWrapper({
   apiKey: ("ENTER_GOOGLE_API_KEY")
})(MapContainer)

Pick an API project and follow the instructions of the README within the API project root.

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

Thanks so much for taking a look at the Places app! As this is a very simple example, there's plenty of potential for customization. Please feel free to submit PR's to the project to include your modifications!

If you have any questions, comments, or would like to contribute to this or future projects like this please reach out to us directly at developers@mariadb.com or on Twitter.

6.9 KiB Raw Blame History Unescape Escape