Skip to main content

Introduction

Let's discover Resonate in less than 5 minutes.

Getting Started​

The simplest way to get started is by getting our music streaming player up and running in your development environment.

What you'll need​

  • Node.js version 14 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
  • A code editor:
    • VSCode is a well-maintained, free option.

Git workflow​

If you are not yet a member of the Resonate team on GitHub, you should fork the repository you want to work on. And then clone your fork. Otherwise, simply clone the repository you want to work on:

git clone <the repo you want to clone . git>
git checkout -b <new branch name>

Do work the work, and then add any files you want to commit:

git status
git add <filename>

Follow Conventional Commits guidelines (chore:, feat:, fix:, cleanup: are common commit message prefixes), and make your commit:

git commit -m "<prefix>: short commit message"

Push your new branch online to create a merge request:

git push origin <new branch name>

Then, to get later changes from the repository, go back to your main branch:

git checkout main

Now, to pull down the latest if you cloned Resonate's repository:

git pull origin main

Or, to pull down the latest if you cloned your fork:

git pull upstream main

Clone repository​

Head over to the Beam documentation to clone and finalize getting your development environment underway.

Or alternatively, continue on to the Overview if you'd like to learn more about the big picture view for Resonate before diving into development.