{"repo":"funmusicplace/mirlo","free":true,"listed":false,"github":"https://github.com/funmusicplace/mirlo","clone":"git clone https://github.com/funmusicplace/mirlo.git","description":"An open source audio distribution and patronage platform","language":"TypeScript","stars":241,"topics":["audio","music","music-player","patronage","patrons","audio-distribution","docker","express","javascript","nodejs"],"license":null,"category":"media-processing","readme_excerpt":"Mirlo A RESTful API and client. Main libraries: - Express - Prisma Client Contributing Download and install Prerequisites: - Docker - Node.js 22 - Yarn 4 Once node is installed, you can use Corepack to automatically install the correct version of yarn (as defined in package.json ): If you'd like to use Nix, we have a basic shell.nix that includes Node.js, Yarn, and other tools to develop the client. Activate the shell using nix-shell at the top-level of the repository. For the API: Go to localhost:3000/docs and see the Swagger API docs. For the client: You can log in with these credentials: Email On production email gets sent by sendgrid or mailgun. To see e-mails during development, navigate to http://localhost:8025 to view all emails. Emails will appear in real-time as they're sent through the queue. If during development you want to send actual emails (e.g. while testing an email provider), configure that provider on your Mirlo instance via the localhost admin UI, and set environment variable: Background Jobs Making changes to background jobs. Changes in background jobs aren't detected. You'll need to restart the docker container for them: Workers (Uploading Music, Images, Etc) If you want to upload music or upload images, you'll need a worker running. NOTE: this is done automatically by the blackbird-background container in docker. NOTE: In local development you can see the worker queue at /admin/queues on the API server when logged in as an admin. In production, also ena","default_branch":null,"files":null,"tree":[],"storefront":"/r/funmusicplace","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/funmusicplace/mirlo/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}