/reason-music-player

simple music player component with useContext in ReasonReact

Primary LanguageReasonMIT LicenseMIT

Contributors Issues MIT License workflow status


Logo

Reason Music Player

A simple music player built with ReasonReact and useContext
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

UPDATE: ReasonML + BuckleScript is now Rescript. As the ecosystem has changed around those tools, this repository is out of date.

A ReasonReact music player with the React Context API

☞ View Demo

This is a port of James King's blog post How to Use the useContext Hook in React to ReasonReact.

With this repository you can see my progress in converting a React.js example to ReasonML and ReasonReact.

It also serves as a code example for a tutorial series. If you want to follow along, you can read the blog posts on dev.to:

Built With

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

Before using reason-music-player you need:

For editor support, check the Reason Docs. For Vim, you can check my blog post about ReasonML Development With Vim.

Installation

  1. Clone the repo
git clone https://github.com/sophiabrandt/reason-music-player.git

(Alternatively, use degit: npx degit sophiabrandt/reason-music-player reason-music-player).

  1. Install NPM packages
cd reason-music-player && npm install

Usage

Run the project locally under http://localhost:3000 via:

npm run start

Create a production build:

npm run build

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Sophia Brandt - @hisophiabrandt

Project Link: https://github.com/sophiabrandt/reason-music-player

Acknowledgements