Skip to content

GreysonElkins/mixdup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MixDup

Contributors Forks Stargazers Issues

View the Site · Report Bug · Request Feature

Table of Contents

About The Project

Mixdup is a progressive web app for making weekly playlists with friends to find new music. Users can vote on their favorite songs each week to prove they have the ultimate hipster clout.

The concept was developed by our Back End team, Ruthie Rabinovitch and Noa Harnik

Currently Mixdup consumes data from a Firebase Realtime database and the Spotify API. Depending on the call, the data is sometimes provided by a middleware express app with it's own Spotify API authentication, but users have the option to authenticate their account as well in the Front End.

This middleware will be depricated by a graphQL database in the future.

Built With

React Hooks
Typescript
SCSS
Firebase
Spotify API

Getting Started Locally

Prerequisites:

  • npm: (npm install npm@latest -g)

Instructions:

  1. Follow the instructions in the Mixdup Back End Repo to run the server side of the app.
  2. Fork the repo
  3. Clone down the forked repo
  4. cd into your local project and run npm install
  5. You will need to add the following variables into a .env file in the root directory. These values can be created at the Spotify Developer dashboard and with a Firebase account.
REACT_APP_MIXDUP_SPOTIFY_CLIENT_ID,
REACT_APP_SPOTIFY_CLIENT_ID,
REACT_APP_FIRE_API_KEY,
REACT_APP_FIRE_AUTH_DOMAIN,
REACT_APP_FIRE_DATABASE_URL,
REACT_APP_FIRE_PROJECT_ID,
REACT_APP_FIRE_STORAGE_BUCKET,
REACT_APP_FIRE_APP_ID,
REACT_APP_FIRE_SENDER_ID
  1. Run the app!
npm start
  1. Go to localhost:3000 in your browser

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request to this branch

Contact

Greyson Elkins - greysonelkins@gmail.com

About

🍸 a collaborative playlist maker with a competitive twist

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published