ryohey/signal

signal is a user-friendly music sequencer application developed using web technologies, designed for seamless, cross-platform use, released under the MIT license.

Architecture

See ARCHITECTURE.md for repository architecture and design policies.

Launch

https://signalmidi.app/edit

Goals

• Cross-Platform Compatibility: Ensure accessibility across various devices and operating systems.
• Simple User Interface: Focus on an intuitive, non-complicated user interface for ease of use.
• MIDI Compatibility: Support for MIDI format to facilitate a wide range of music production needs.

Concepts

signal is conceptualized not as a replacement for a Digital Audio Workstation (DAW), but as a complementary tool. It excels during the initial stages of music composition and sketching, allowing artists to quickly and efficiently lay down their musical ideas. To keep the focus on composition without distractions, signal comes with intentional limitations:

• Basic Sound Quality: Prioritizes simplicity over high-quality sound production.
• No Effects (Fx): Excludes sound effects to streamline the music creation process.
• Lightweight Design: Optimized for minimal resource usage, ensuring a fast and responsive user experience.

By setting these constraints, signal aims to offer a streamlined and distraction-free environment, ideal for artists focusing on the core aspects of musical composition and idea development.

Setup Instructions

Cloning the Repository

1. Open your terminal.
2. Clone the repository by running:

   git clone https://github.com/ryohey/signal.git
   

3. Navigate into the project directory:

   cd signal
   

Installing Dependencies

1. In the project root directory, run the following command to install the required dependencies:

   corepack enable
   pnpm install
   

Running the Application

[!NOTE] The first time you run it, you will get a build error, so please run pnpm build once before running pnpm dev.

1. To start the application, run:

   pnpm dev
   

2. The application should now be running on http://localhost:3000.

Running via Docker

[!NOTE] with docker, pnpm install and pnpm build will not be necessary, and you will only need to install docker, then clone the repository, then run the command specified below.

1. to run via docker, run:

   docker compose up
   # or
   docker compose up -d
   

2. The application should now be accessible on http://localhost:3000.

Contribution

As the creator of signal, I, @ryohey, welcome any form of contribution to this music sequencer application. Your support, whether it's through code improvements, bug fixes, or feedback, is invaluable in enhancing and evolving signal.

Reporting Bugs

• Encountered a bug? Please use GitHub Issues to report it. Your reports are crucial in identifying and resolving problems, ensuring a smoother experience for everyone.

Join Our Discord Community

• I've set up a Discord community for signal users. It's a space for mutual support, sharing tips, and discussing music production. Your participation would be a wonderful addition to our growing community.

Support Through GitHub Sponsors

• signal is a personal project that I've been passionately developing. If you like what you see and wish to support my efforts, you can do so through GitHub Sponsors. Even the smallest contribution can make a significant difference and is deeply appreciated.

Your engagement, big or small, contributes greatly to the development of signal. Thank you for being a part of this journey, and I'm eager to see the impact of your contributions on this application.

License

MIT. See LICENSE