Skip to content

Latest commit

 

History

History
111 lines (64 loc) · 4.67 KB

README.md

File metadata and controls

111 lines (64 loc) · 4.67 KB
Raw

Gigify

Commitizen friendly

Gigify is an artist discovery tool. It uses Songkick event data to display upcoming concerts that you might be interested in and allows you to make Spotify playlists to help you learn more about supporting artists and better plan your night out. You can also receive SMS reminders of upcoming gigs and purchase tickets.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Note, these steps are not required to run our deployed version of Gigify.

  1. Fork and clone the repo.

  2. To install dependencies, navigate to the downloaded repo directory directory using the command line and run: npm install

  3. Create a new application on the Spotify Developer Site to obtain an API key.

  4. Request a Songkick API key. Be prepared to wait at least a week and to be asked to justify your request before a key is granted. The Songkick API Forum can be helpful if it takes too long. Songkick staff respond to questions there.

  5. Create a Twilio account and request an API key.

Installing

Gigify requires a .env file to be created before running it. This file should be placed in the root of your directory and should look like this:

TWILIOSID=(replace with Twilio ID) // Provided by Twilio
TWILIOAUTHTOKEN=(replace with Twilio auth token) Provided by Twilio
APP_KEY= (replace with Spotify app key) // Provided by Spotify
APP_SECRET= (replace with Spotify app secret) // Provided by Spotify
SONGKICK_KEY=8CwyZanXp3Y52D1K (replace with Songkick API key) // Provided by Songkick
PGDATABASE=(replace with PostgreSQL database name)
PGUSER=(replace with PostgreSQL username)
PGPASSWORD=(replace with PostgreSQL password)
PGURL=(replace with url of PostgreSQL database or localhost)
PGPORT=5432 (This is the default PostgreSQL port, change if necessary)

Using

Login

Splash

Spotify Login

Note: A Spotify account is required to use Gigify. Spotify credentials are never handled by Gigify and are transmitted securely to Spotify only.

Search

Enter your Songkick Username if you have one.

Songkick

Or select a genre search. These searches only are valid in New York City at this time.

Genre Search

Select Gigs and make a playlist

Playlist Creation

Built With

  • Express- Flexible Node.js web application framework
  • Node.js - JavaScript runtime
  • Passport - Simple authentication for Node.js
  • Particles.js - Lightweight JavaScript library for creating particles
  • PostgreSQL - Object-relational database
  • React - JavaScript library for building user interfaces
  • Redux - Predictable state container for JavaScript apps
  • SASS - CSS extension language
  • Twilio - Messaging platform
  • Webpack - Module bundler

Data Sources

  • Songkick API - Songkick gives you easy access to over 5 million upcoming and past concerts

  • Spotify API - With Spotify, it’s easy to find the right music for every moment – on your phone, your computer, your tablet and more.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Contributors will be gratefully acknowledged.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Authors

Made with ❤️ in New York City by:

Gigify