|
1 | 1 | <p align="center"> |
2 | | - <img src="https://github.com/openpeeps/PKG/blob/main/.github/logo.png" width="90px"><br> |
3 | | - OpenPeeps repository template for developing libraries,<br>projects and other cool things. 👑 Written in Nim language |
| 2 | + <img src="https://github.com/openpeeps/stupidgreen/blob/main/.github/stupidgreen.png" width="110px" height="110px"><br> |
| 3 | + StupidGreen — The Open-Source Platform for Independent Musicians<br> |
| 4 | + Music Catalog • Tour Events • Merch • 100% Customizable • Self-Hosted • |
4 | 5 | </p> |
5 | 6 |
|
6 | 7 | <p align="center"> |
7 | | - <code>nimble install {PKG}</code> |
| 8 | + <code>nimble install stupidgreen</code> |
8 | 9 | </p> |
9 | 10 |
|
10 | | -<p align="center"> |
11 | | - <a href="https://github.com/">API reference</a><br> |
12 | | - <img src="https://github.com/openpeeps/pistachio/workflows/test/badge.svg" alt="Github Actions"> <img src="https://github.com/openpeeps/pistachio/workflows/docs/badge.svg" alt="Github Actions"> |
13 | | -</p> |
| 11 | +## About StupidGreen |
| 12 | +StupidGreen is an **open-source**, **self-hosted music platform** desgined to empower independent artists to **share their music with the world**. With a super simple and intuitive interface, StupidGreen makes it easy for musicians to customize their website, upload music and merch and connect with fans. StupodGreen is for everyone, from bedroom beatmakers to touring bands. |
| 13 | + |
| 14 | +StupidGreen is written in [Nim](https://nim-lang.org), a fast and efficient programming language that compiles to native code. This allows StupidGreen to be lightweight and performant, even on modest hardware! |
| 15 | + |
| 16 | +> [!NOTE] |
| 17 | +> StupidGreen is currently in early development! If you're interested in contributing or have ideas for features, don't hesitate to reach out or submit a pull request! |
| 18 | +
|
| 19 | + |
| 20 | +## Key features |
| 21 | +- [x] Fast, compiled and super lightweight |
| 22 | +- [x] Modern, responsive design built with Supranim and Bootstrap 5 |
| 23 | +- [x] Music Catalog with album, single, and EP support |
| 24 | +- [x] Biography and artist profile pages |
| 25 | +- [x] Countact form for booking inquiries and fan messages |
| 26 | +- [x] Audio player with continuous playback and playlist support |
| 27 | +- [x] Audio waveform visualization for each track |
| 28 | +- [x] Customizable artist profiles and discography pages |
| 29 | +- [ ] Embeddable music player widget for external websites |
| 30 | +- [ ] Open-Graph Generator for rich social media sharing |
| 31 | +- [ ] Member-only content and subscription support |
| 32 | +- [ ] Tour dates and event management features |
| 33 | +- [ ] Merch store for selling physical and digital products |
| 34 | +- [ ] Lemonsqueeze/Stripe integration for payments and subscriptions |
| 35 | +- [ ] Admin dashboard for managing content and users |
| 36 | +- [ ] RESTful API for third-party integrations and mobile apps |
| 37 | +- [ ] RSS/Feed support for new releases and tour dates |
| 38 | + |
| 39 | +## Installation |
| 40 | +The most straightforward way to get StupidGreen up and running is to use Nimble, the package manager for Nim. If you don't have Nimble installed, you can follow the instructions on the [Nim website](https://nim-lang.org/install.html) to set it up. Once you have Nimble installed, simply run the following command in your terminal: |
| 41 | + |
| 42 | +```bash |
| 43 | +nimble install stupidgreen |
| 44 | +``` |
14 | 45 |
|
15 | | -## 😍 Key Features |
16 | | -- [x] Open Source | `MIT` License |
17 | | -- [x] Written in Nim language |
| 46 | +## Usage |
| 47 | +After installing StupidGreen, you can initialize a new StupidGreen project in your desired directory by running: |
| 48 | +```bash |
| 49 | +stupidgreen init awesome-band |
| 50 | +``` |
18 | 51 |
|
19 | | -## Examples |
20 | | -... |
| 52 | +Then, navigate to the project directory and start the development server with: |
| 53 | +```bash |
| 54 | +stupidgreen start --port 4000 |
| 55 | +``` |
21 | 56 |
|
22 | 57 | ### ❤ Contributions & Support |
23 | | -- 🐛 Found a bug? [Create a new Issue](/issues) |
24 | | -- 👋 Wanna help? [Fork it!](/fork) |
| 58 | +- 🐛 Found a bug? [Create a new Issue](https://github.com/openpeeps/stupidgreen/issues) |
| 59 | +- 👋 Wanna help? [Fork it!](https://github.com/openpeeps/stupidgreen/fork) |
25 | 60 | - 😎 [Get €20 in cloud credits from Hetzner](https://hetzner.cloud/?ref=Hm0mYGM9NxZ4) |
| 61 | +- 🥰 [Donate via PayPal address](https://www.paypal.com/donate/?hosted_button_id=RJK3ZTDWPL55C) |
26 | 62 |
|
27 | 63 | ### 🎩 License |
28 | | -{PKG} | MIT license. [Made by Humans from OpenPeeps](https://github.com/openpeeps).<br> |
29 | | -Copyright OpenPeeps & Contributors — All rights reserved. |
| 64 | +StupidGreen | `AGPLv3` license. [Made by Humans from OpenPeeps](https://github.com/openpeeps).<br> |
| 65 | +Copyright © 2026 OpenPeeps & Contributors — All rights reserved. |
0 commit comments