Πώς να δημιουργήσετε το δικό σας Santa Tracker με το Gatsby και το React Leaflet

Η περίοδος των Χριστουγέννων είναι μια μαγική εποχή του χρόνου. Έχουμε τον Άγιο Σάντα να πετάει γύρω από τη χαρά και το Elf να περιφέρεται στη Νέα Υόρκη κατά τη διάρκεια της ετήσιας επανάληψης με την οικογένεια και τους φίλους μας.

Για να αποκτήσουμε το πνεύμα, θα δημιουργήσουμε μια εφαρμογή ιστού που περιλαμβάνει έναν χάρτη που παρακολουθεί τον Άγιο Βασίλη!

Επεξεργασία 12/23: Ενημερώθηκε η εφαρμογή για να ζητηθεί απευθείας στη διαδρομή του Αϊ-Βασίλη, σε περίπτωση που το αρχικό API δεν λειτουργεί όπως αναμενόταν αρχικά

Τι πρόκειται να οικοδομήσουμε;

Θα δουλέψουμε δημιουργώντας μια εφαρμογή χαρτογράφησης που παρακολουθεί τη διαδρομή του Σάντα και την τρέχουσα τοποθεσία του.

Για να το επιτύχουμε αυτό, πρόκειται να δημιουργήσουμε ένα προπαρασκευαστικό εκκινητή Gatsby που θα μας δώσει μια βασική βάση για έναν χάρτη, θα χρησιμοποιήσουμε το ανεπίσημο API της Google για να αρπάξουμε τη διαδρομή του Σάντα και να επικαλύψουμε τη θέση και τη διαδρομή του πάνω από τον χάρτη με το Leaflet.

Ωχ, μια εφαρμογή χαρτογράφησης;

Ναι. Εάν δεν έχετε παίξει με χάρτες στο παρελθόν, μην αποθαρρύνεστε! Δεν είναι τόσο κακό όσο νομίζεις. Εάν προτιμάτε να ξεκινήσετε με τα βασικά χαρτογράφησης, μπορείτε να διαβάσετε περισσότερα σχετικά με τον τρόπο λειτουργίας της χαρτογράφησης πρώτα.

Τι χρειαζόμαστε πριν ξεκινήσουμε;

Για αυτήν την άσκηση, θα υποθέσω ότι έχετε εγκαταστήσει κόμβο ή νήματα. Για κάθε παράδειγμα, θα χρησιμοποιήσω νήματα, αλλά θα χρησιμοποιήσω το εργαλείο της επιλογής σας.

Θα θέλατε επίσης να εγκαταστήσετε το CLI του Gatsby παγκοσμίως, το οποίο θα μας επιτρέψει να χρησιμοποιήσουμε τα εργαλεία εκκίνησης.

Για να ρυθμίσετε το CLI του Gatsby, εκτελέστε την ακόλουθη εντολή:

yarn global add gatsby-cli

Μετά, θα πρέπει να μπορείτε να εκτελέσετε gatsby -hγια να δείτε τις διαθέσιμες εντολές, πράγμα που σημαίνει ότι έχει εγκατασταθεί με επιτυχία.

Για περισσότερες πληροφορίες σχετικά με το Gatsby CLI, μπορείτε να δείτε την τεκμηρίωσή τους.

Ξεκινώντας με τη βάση χαρτών μας

Μόλις ρυθμιστούν τα εργαλεία της γραμμής εντολών, το πρώτο πράγμα που θα θέλαμε να κάνουμε είναι να δημιουργήσουμε ένα νέο έργο Gatsby χρησιμοποιώντας έναν εκκινητή Leaflet που έβαλα μαζί. Μας παρέχει μια βασική ρύθμιση με το Leaflet και το React Leaflet.

Ξεκινώντας από τον κατάλογο του έργου σας, ας εγκαταστήσουμε το έργο:

gatsby new [directory] //github.com/colbyfayock/gatsby-starter-leaflet 

Βεβαιωθείτε ότι έχετε αντικαταστήσει [directory]με την τοποθεσία που θέλετε να ρυθμίσετε το έργο σας.

Μόλις εκτελέσετε αυτήν την εντολή, το Gatsby θα κλωνοποιήσει αυτό το έργο χωρίς καμία από τις αναφορές git και θα εγκαταστήσει τα πακέτα που απαιτούνται για να ξεκινήσει.

Για να βεβαιωθείτε ότι λειτουργεί, μπορείτε πλέον να μεταβείτε σε αυτόν τον κατάλογο, να περιστρέψετε τον διακομιστή σας και να τον δοκιμάσετε στο πρόγραμμα περιήγησης:

cd [directory] yarn develop 

Όπου βλέπετε [directory]παραπάνω, φροντίστε να χρησιμοποιήσετε την ίδια διαδρομή που κάνατε πριν κατά τη δημιουργία του νέου έργου Gatsby.

Εάν όλα πάνε όπως έχει προγραμματιστεί, ο διακομιστής σας θα πρέπει να ξεκινήσει και τώρα θα μπορείτε να δείτε τη βασική εφαρμογή χαρτογράφησης στο πρόγραμμα περιήγησής σας!

Καθαρίστε τα πράγματα

Αυτός ο εκκινητής συνοδεύεται από ένα γρήγορο παράδειγμα για το πώς μπορούμε να αλληλεπιδράσουμε με το χάρτη. Δεν θα το χρειαζόμαστε καθόλου για τους σκοπούς μας, ώστε να μπορούμε να προχωρήσουμε και να καθαρίσουμε τα πράγματα.

Για να ξεκινήσουμε, θα ανοίξουμε το index.jsαρχείο μας , το αρχείο αρχικής σελίδας και θα απαλλαγούμε από όλα όσα βρίσκονται μέσα στη mapEffectλειτουργία, η οποία μας αφήνει:

// In src/pages/index.js async function mapEffect({ leafletElement } = {}) { // Get rid of everything in here } 

Τώρα, ας αφαιρέσουμε το Markerστοιχείο που βρίσκεται μέσα στο δικό μας Map, οπότε καταλήγουμε με:

Τώρα που δεν χρησιμοποιούμε πλέον αυτήν τη λειτουργικότητα, μπορούμε να απαλλαγούμε από τις μεταβλητές και τις αναφορές στην κορυφή του αρχείου, ώστε να μπορείτε να προχωρήσετε και να καταργήσετε:

  • χρησιμοποιήστεRef
  • janjiToFlyTo
  • getCurrentLocation
  • Σημάδι
  • gatsby_astronaut
  • ΑΝΙΠΤΑΜΑΙ ΔΙΑΓΩΝΙΩΣ
  • timeToZoom
  • timeToOpenPopupAfterZoom
  • timeToUpdatePopupAfterZoom
  • popupContentΓεια σας
  • popupContentGatsby
  • δείκτηςRef

Ακολουθήστε μαζί με τη δέσμευση.

Βρίσκοντας τον Άγιο Βασίλη

Τώρα που είμαστε σε καλό μέρος, ας βρώσουμε τα χέρια μας και βρούμε τον Άγιο. Για να το κάνουμε αυτό, θα χρησιμοποιήσουμε το ανεπίσημο API χωρίς έγγραφα της Google. Αυτό σημαίνει ότι είναι πιθανό αυτό το API να μην είναι διαθέσιμο την επόμενη ημέρα από τη δημοσίευσή του.

Additionally, at the time of writing, it’s still showing last year’s destinations, so what we’re really going to be visualizing here is Santa’s previous year’s route, though the hope is this would reset on the 24th and we’ll all be merry!

Before we get Santa, let’s first add a line back to our mapEffect function:

async function mapEffect({ leafletElement } = {}) { if ( !leafletElement ) return; } 

What this will do is prevent the rest of our code from running in the event our map isn't ready yet. The mapEffect function itself, as you can see in the Map component, runs inside of an instance of useEffect passing an argument of a ref to the map, allowing us to run some code after our component renders.

So once we have that line, let’s now fetch Santa’s route inside of our mapEffect function:

async function mapEffect({ leafletElement } = {}) { if ( !leafletElement ) return; let route, routeJson; try { route = await fetch('//firebasestorage.googleapis.com/v0/b/santa-tracker-firebase.appspot.com/o/route%2Fsanta_en.json?alt=media&2018b'); routeJson = await route.json(); } catch(e) { console.log(`Failed to find Santa!: ${e}`); } console.log(‘routeJson’, routeJson); }

Let’s break this down:

  • We grab Santa’s route via the API endpoint
  • Once we have his route, we grab the response in a JSON format to make it easier to work with
  • This is all wrapped in a try/catch so we can safely handle any response errors
  • Finally, we just log out our response for now

Now we have Santa and his route, which means we can see all the destinations in his route. If you dig in the response a little bit, you can see some fun things like how many presents were delivered to each location and the weather at the time!

Follow along with the commit.

Put a pin in his location

We found Santa! ? Now let’s put him on the map.

For our purposes, we’ll need to find the latitude and longitude of Santa. The problem is, we don’t get this exact value defined anywhere, we just get his destinations.

Since we don’t have his location specified anywhere, we can utilize his last known location where presents were delivered. Add the following after our last snippet inside the mapEffect function:

const { destinations = [] } = routeJson || {}; const destinationsVisited = destinations.filter(({arrival}) => arrival  presentsDelivered > 0); const lastKnownDestination = destinationsWithPresents[destinationsWithPresents.length - 1]

Below our request code, we:

  • Destructure routeJson to grab destinations into a constant, adding a fallback to an empty object
  • Filter the results to only find the destinations that he's visited, using the arrival time from the route object
  • Filter the results to find only the locations with presents
  • And finally grab the last item from the array, which shows his last known location

At this point in time, 12/23, we don't actually have any destinations, as Santa is still at the North Pole. At any time, we can test this out to simulate a future date by replaceing Date.now() in destinationsVisited with a future date, such as 1577188980000 which would be around 7pm Eastern on 12/24. With that change, we can see what Santa's route actually looks like!

Handle a missing Santa

Now that it's close to Christmas, Santa will still be at the North Pole, so let's handle the case where we don't have a location.

Above the line where we set lastKnownDestination, let's add:

if ( destinationsWithPresents.length === 0 ) { // Create a Leaflet Market instance using Santa's LatLng location const center = new L.LatLng( 0, 0 ); const noSanta = L.marker( center, { icon: L.divIcon({ className: 'icon', html: ` ? `, iconSize: 50 }) }); noSanta.addTo( leafletElement ); noSanta.bindPopup( `Santa's still at the North Pole!` ); noSanta.openPopup(); return; }

Okay so what are we doing here?

  • First, we’re checking if we have any destinations with presents, which here we don't
  • We first create a LatLng of the center of the map
  • We create a Leaflet marker, using that center, with a custom Icon of Santa
  • Next we add that Santa marker to the leafletElement, which is our map
  • To show a message, we first bind a popup with a custom message and open it
  • Finally we return so the rest of the code doesn’t run, as we don’t have Santa at this point

This was a section added after published to handle the API resetting, but you can still follow along with the code I added in context of the rest of the rest of the code.

Follow along in the code.

Pinning Santa

Edit 12/23: This section was originally written with the previous year's API, but this is still a good example of what you'll expect on the response, so you can follow right along.

And as we can see, since we’re looking at last year’s data, Santa is back home at the North Pole.

With his location, we can pull that apart, set up a Leaflet marker instance, and add our old friend to the map. Add the following after our last snippet inside the mapEffect function:

const santaLocation = new L.LatLng( lastKnownDestination.location.lat, lastKnownDestination.location.lng ); const santaMarker = L.marker( santaLocation, { icon: L.divIcon({ className: ‘icon’, html: ` ? `, iconSize: 50 }) }); santaMarker.addTo(leafletElement);

Here we:

  • Create a Leaflet LatLng instance with his location
  • Create a Marker instance with our newly created LatLng instance
  • Add our new Marker to the map

If we refresh our page, you’ll have to zoom out and pan up a little bit, but we'll see Santa on the map!

Before we move on, let’s give Santa a little holiday cheer to make him easier to find. Find your application.scss file and toss these styles in:

// In src/assets/stylesheets/application.scss .icon { & > div { display: flex; justify-content: center; align-items: center; overflow: hidden; border-radius: 100%; box-shadow: 0 3px 4px rgba(0,0,0,.4); border: none; transition: all .2s; &:hover { box-shadow: 0 4px 8px rgba(0,0,0,.6); } } } .icon-santa { width: 50px; height: 50px; font-size: 3em; background: white; } 

This just adds a white circle around him, a little drop shadow, and increases the size a bit to make him a little easier to find on the map.

Follow along with the commit.

Drawing his route

The last thing we’re going to do here is draw a path on the map showing his route so we can follow along.

To get started, let’s update our code and add this last bit after our last snippet in the mapEffect function:

// Create a set of LatLng coordinates that make up Santa's route const santasRouteLatLngs = destinationsWithPresents.map(destination => { const { location } = destination; const { lat, lng } = location; return new L.LatLng( lat, lng ); }); // Utilize Leaflet's Polyline to add the route to the map const santasRoute = new L.Polyline( santasRouteLatLngs, { weight: 2, color: 'green', opacity: 1, fillColor: 'green', fillOpacity: 0.5 }); // Add Santa to the map! santasRoute.addTo(leafletElement); 

What we’re doing:

  • Creating an array of Leaflet LatLng instances that make up Santa’s route
  • Creating a Leaflet Polyline (a multi-point line) using that routes array
  • Make that Polyline green
  • Add our Polyline to the map

What we get… is a bunch of squiggly lines!

This is expected. This gets technical really fast, but Leaflet by default can only understand 1 “portion” of the map as it wraps around in our browser. What this realistically means, is instead of drawing a line around a globe, the coordinates think it goes from one side of the world to the other as it hits the International Dateline. This is a bit out of scope for this tutorial, but you can check out Leaflet.Antimeridian to learn more and see if you can implement the solution to it.

Follow along with the commit.

A few quick style tweaks

One last thing! And this is completely optional. Let’s make the map a little bit bigger, set the background color to match our oceans, and zoom out a little bit. So let’s make a few changes:

// In src/pages/index.js const DEFAULT_ZOOM = 1; 

We’re setting our default zoom to 1 instead of 2 to allow the map to be zoomed out a bit.

// In src/assets/stylesheets/pages/_home.scss .page-home { .map, .map-base { height: 80vh; } }

We’re setting our map to a height of 80vh instead of 50vh to make it take up a little more of our screen.

// In src/assets/stylesheets/components/_map.scss .map { &, .map-base { background: #acd3de; } }

We’re setting the background color of our map to #acd3de instead of $blue-grey-50 which allows us to match the color of the oceans on our map.

What this achieves is being able to see Santa’s full route and Santa on the first view. Additionally, since the map only covers part of the screen, setting the background color of the map allows us to not have a little bit of a weird cutoff.

Follow along with the commit.

Want a challenge?

To take this 1 step further, follow along with both how we added the routes and Santa to the map and try to see if you can add a marker to each destination location to show where all of the stops are. Bonus, add a popup to each one that says how many presents were delivered to that location!

To see the answer with some code organization and how I added the gift markers, check out the final version of the Santa Tracker demo.

While you’re there, you can also see how I utilized Leaflet.Antimeridian to fix our map's route.

What did we learn?

Building basic apps with a map isn’t nearly as bad as we thought! We learned how to fetch some data from an API, grab the data we need, and draw representations of that data on a map.

Next time you want to add a map widget to your landing page, try Leaflet. Share what you create on Twitter! Would love to see what you come up with.

I hope you and your family have a fantastic holiday season!

Want to learn more about maps?

You can check out a few of my other resources to get started:

  • Anyone Can Map! Inspiration and an introduction to the world of mapping
  • How to create a Coronavirus (COVID-19) Dashboard & Map App in React with Gatsby and Leaflet
  • How to set up a custom Mapbox basemap style with React Leaflet and Leaflet Gatsby Starter
  • How to Create a Summer Road Trip Mapping App with Gatsby and Leaflet
  • How to build a mapping app in React the easy way with Leaflet

Ακολουθήστε με για περισσότερα Javascript, UX και άλλα ενδιαφέροντα πράγματα!

  • ? Follow Me On Twitter
  • ?️ Subscribe To My Youtube
  • ✉️ Sign Up For My Newsletter

Θέλετε να διαβάσετε μερικά από τα άλλα άρθρα μου; Δείτε το ιστολόγιό μου: //www.colbyfayock.com/2019/12/create-your-own-santa-tracker-with-gatsby-and-react-leaflet/