The Donovan's Piano Room - Music Games

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js: Download & Install Node.js (make sure it's node version 18)

Installation

1. Clone this repository:

   git clone https://github.com/The-Donovans-Venom-501c3/music-games.git

2. Navigate to the project directory:

   cd music-games

3. Pull the latest changes from the develop branch.

   git checkout develop
   git pull origin develop

4. Install the required dependencies:

   npm install

Usage

To start the development server and run the app locally, use the following command:

npm run dev

The app will be accessible at http://localhost:3000 in your web browser.

Contributing

1. Create a new branch for your changes:

    git checkout -b your-branch-name

   Branch name should always be the feature you've implemented. Example: user-authentication

2. Make your changes, commit them, and push them to your branch:

   git add .
   git commit -m "Add your commit message here"
   git push origin your-branch-name

3. Create a Pull Request (PR) from your branch to the develop branch. Provide a descriptive title and a summary of all of your changes.

We will review your PR as soon as possible. Thank you for contributing!