sidebar

About the Project

Sidebar is a service responsible for delivering content and representational data as a module for kle-io, a single page music player app. 🤘

Demos

• Service (Live)
• App

Features

• The main page with render the service for 1 of 100 available songs
• Add a number to the end of the url to see a new song
• Play any song from the "Related Tracks" section
• Auto-play for the next song in the "Related Tracks" list

Built With

• React
• Styled Components
• Express.js
• Sequelize
• Jest
• Enzyme
• Webpack
• Grunt
• GitHub Actions
• AWS ECS
• Docker
• ✨ A little razzle dazzle ✨

Getting Started

Requirements

• MySQL
• NodeJS - An nvmrc file is included if using nvm.

Installation

Clone the project

git clone https://github.com/desrogers/sidebar.git

Install NPM packages

npm i

Configure environment Variables

1. Duplicate .env.example file
2. Rename to .env
3. Replace placeholder credentials in .env

Add data to database

npx sequelize init:config && npm run db:setup

Run build (this will tell Webpack to watch for changes)

npm run dev

Start the server

npm start

Open your favorite browser and visit http://localhost:3004

Roadmap

See the project Trello board for ticket history, current status, and future plans.

Contributing

Pull requests are welcome and greatly appreciated. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

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