Minimal Google Map

Explanation

@mrdoomy/mnml-gmap-react and @mrdoomy/mnml-gmap-vue are components to simply inject Google Maps 🌍 inside your projet.

These libraries are published under the Beerware license, which means you can do whatever you want with the code.

These projects are powered by ViteJS.

How To Use

First of all, you need to install the package:

With React:

  npm install @mrdoomy/mnml-gmap-react

With Vue:

  npm install @mrdoomy/mnml-gmap-vue

Then, use the component as these samples below:

The React way:

  import React from 'react';
  import { GMap } from '@mrdoomy/mnml-gmap-react';
  import styleArray from './styleArray';

  /**
   * The 'keyke' (Key + Fake = Cake) is a lie
   * NB: Worst pun ever; i know that...
   */
  const API_KEY = '01wNJmwnZEabSeRBV4vQRV1JMUx1MvyMyA6edTN49PF/yf0aUjY2F4NZfIOq/Yh7x0d38+21sEP6Tck/jEmXdw==';
  const EIFFEL_TOWER = { lat: 48.8619, lng: 2.2945 };
  const BIG_BEN = { lat: 51.5021, lng: -0.1242 };
  const COLISEUM = { lat: 41.8961, lng: 12.4879 };

  function App() {
    return (
      <div className="container">
        <GMap
          apiKey={API_KEY}
          defaultCenter={EIFFEL_TOWER}
          defaultZoom={5}
          markers={[
            { ...EIFFEL_TOWER, onClick: () => console.log('Eiffel Tower') },
            { ...BIG_BEN, onClick: () => console.log('Big Ben') },
            { ...COLISEUM, onClick: () => console.log('Coliseum') }
          ]}
          styledMap={styleArray}
          enableUI
        />
      </div>
    );
  }

The Vue way:

  <template>
    <div class="container">
      <GMap
        :apiKey="apiKey"
        :defaultCenter="location"
        :defaultZoom="5"
        :markers="markers"
        :styledMap="styleArray"
        :enableUI="true"
      />
    </div>
  </template>

  <script>
  import { GMap } from '@mrdoomy/mnml-gmap-vue';
  import styleArray from './styleArray';

  /**
    * The 'keyke' (Key + Fake = Cake) is a lie
    * NB: Worst pun ever; i know that...
    */
  const API_KEY = 'YLzo6G7hJxAg55x/EvkEaPTvoO/PhQ9ASxzZ5A6OsNJLE4dxq+zK2lJ5Ta7/z5bbtQ9C2f2jDRRW6JyUArVIpQ==';
  const EIFFEL_TOWER = { lat: 48.8619, lng: 2.2945 };
  const BIG_BEN = { lat: 51.5021, lng: -0.1242 };
  const COLISEUM = { lat: 41.8961, lng: 12.4879 };

  export default {
    components: {
      GMap
    },
    computed: {
      apiKey: () => API_KEY,
      styleArray: () => styleArray
    },
    data() {
      return {
        location: { lat: EIFFEL_TOWER.lat, lng: EIFFEL_TOWER.lng },
        markers: [
          {
            ...EIFFEL_TOWER,
            onClick: () => console.log('Eiffel Tower')
          },
          {
            ...BIG_BEN,
            onClick: () => console.log('Big Ben')
          },
          {
            ...COLISEUM,
            onClick: () => console.log('Coliseum')
          }
        ]
      };
    }
  };
  </script>

Important

You need to create a account on cloud.google.com, and generate an API_KEY, to use Google Maps API (and so this component).

Local Development

If you want more,

You can clone the project:

For React:

git clone https://github.com/mrdoomy/minimalgooglemapreact.git

For Vue:

git clone https://github.com/mrdoomy/minimalgooglemapvue.git

Install dependencies:

yarn install

Develop locally:

yarn dev

Run all unit tests:

yarn test

And finally compile the project:

yarn build

Enjoy πŸ‘

License

"THE BEER-WARE LICENSE" (Revision 42):
<phk@FreeBSD.ORG> wrote this file. As long as you retain this notice you
can do whatever you want with this stuff. If we meet some day, and you think
this stuff is worth it, you can buy me a beer in return. Damien Chazoule