musicblocks

(β˜… 869)

Music Blocks -- A musical microworld

Showing a partial file list β€” download the zip above to see everything.

  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .npmrc
  • .nvmrc
  • .prettierignore
  • .prettierrc
  • .release-please-manifest.json
  • AGENTS.md
  • AI-Debugger-widget-guide.md
  • android_chrome_manifest.json
  • CHANGELOG.md
  • commitlint.config.js
  • config.xml
  • CONTRIBUTING.md
  • convert_po_to_json.py
  • COPYING
  • CREDITS.md
  • cypress.config.js
  • DEBUGGER-TOOL-GUIDE.md
  • Debugging.md
  • dockerfile
  • DOCS_MODULE_ARCHITECTURE.md
  • electron-main.js
  • env.js
  • eslint.config.mjs
  • favicon.ico
  • generate_pdf.js
  • GOVERNANCE.md
  • gulpfile.js
  • gulpfile.mjs
  • Licence.txt
  • MAINTAINERS.md
  • Minsky.jpg
  • Music_Blocks_for_Snap_Users.md
  • NEWS
  • PERFORMANCE.md
  • README-ja.md
  • README.md
  • REFLECTION-WIDGET-GUIDE.md
  • REVIEW_GUIDELINES.md
  • TOUCH-SUPPORT-AUDIT.md
  • WCAG-AUDIT-REPORT.md
  • WhyMusicBlocks.md

# Installation Guide

1. Get the code
git clone https://github.com/sugarlabs/musicblocks

Downloads the entire project code from GitHub to your computer.

cd musicblocks

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t musicblocks .

Builds a runnable image based on the Dockerfile.

docker run -p 3000:3000 musicblocks

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

// repository documentation