Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 2.95 KB

README.md

File metadata and controls

86 lines (54 loc) · 2.95 KB
Raw

Artist Map

Explore band gigographies. Created with Mapbox, React, Redux, Songkick API, and Express.

Demo @ https://artistmap.herokuapp.com.

Screenshot

Getting Started

Install Dependencies

Run ./install.sh. Alternatively, you can run yarn install in both the root and in /src/server.

Getting a Songkick API key and a Mapbox public token

This project utilizes the Songkick API for artist and concert data and Mapbox GL for visualization.

If you don't have a Songkick API key you can apply for one here. If you don't have a Mapbox public token you can get one by making a Mapbox account here.

Storing API Keys

You'll need to supply your own Songkick key and mapbox public token.

Mapbox

Add your public token to /src/client/config.js. It should look like the following:

export const MAPBOX_TOKEN = // YOUR MAPBOX PUBLIC TOKEN

Songkick

Add your Songkick key to /src/server/.env. It should look like the following:

SONGKICK_KEY = # YOUR SONGKICK API KEY

config.js and .env have been added to the .gitignore, but it's probably worth the check to see if they are being ignored in your environment as to keep your key and token safe.

Running

yarn dev will start both the react app and express API server. Alternatively, you can run the react app with yarn client and the express API server with yarn server.

Contributing

If you'd like contribute feel free to create a pull request.

Higher Priority

  • Fix bug in search causing error fetching (proxy and .env problem)
  • Move songkick api calls over to backend
  • Update README for .env file
  • Add number of concert results to response
  • Migrate from markers to a cluster layer
  • Update cluster style expressions to better fit data
  • Fallback to city coordinates if no venue coordinate data
  • Concert API to return geojson data instead of concert array
  • Deployment for demo
  • Search suggestions
  • Loading animation
  • Grab more search suggestions (25?), only send the most popular 5 back to client
  • UI animations with react-pose
  • Popup if search found no artist matches
  • Handle api timeouts (migrate from fetch to axios)

Lower Priority

  • Filter server data to only include salient properties (artistId, artistName, venueId, venueName, venueLocation, cityName, cityLocation, date)
  • Add Popup on individual venue points
  • Add songkick credits
  • Create production script