Stellar-Polyphony

A decentralized platform for connecting musicians and audiences through real-time performances and blockchain-based tipping.

Overview

Stellar-Polyphony is a modern web application built on a monorepo architecture that enables street performers, indie artists, and musicians to broadcast live performances to a global audience while receiving direct support through cryptocurrency tips.

Key Features

Live Performance Discovery: Browse and discover live performances from artists worldwide
Real-time Streaming: Watch performances as they happen
Blockchain Tipping: Support artists directly using Stellar blockchain
Artist Profiles: Customizable profiles for performers
Session Management: Artists can create, manage, and broadcast live sessions
Admin Dashboard: Moderation and oversight tools

Architecture

This project uses a monorepo structure powered by:

pnpm workspaces: Efficient package management
Turbo: High-performance build system
TypeScript: Type-safe development
Modular design: Separation of apps and shared packages

Project Structure

stellar-polyphony/
├── apps/                    # Application workspaces
│   ├── web/                # Public-facing web application
│   ├── api/                # Backend API service
│   └── admin/              # Admin dashboard
├── packages/               # Shared packages
│   ├── types/             # Shared TypeScript types
│   ├── ui/                # Shared UI components
│   └── config/            # Shared configuration
├── tooling/               # Development tools and scripts
├── docs/                  # Documentation
└── .github/               # CI/CD workflows

Getting Started

Prerequisites

Node.js >= 18.x
pnpm >= 8.x
Git

Installation

Clone the repository:

git clone https://github.com/yourusername/Stellar-Polyphony.git
cd Stellar-Polyphony

Install dependencies:

pnpm install

Set up environment variables:

cp .env.example .env
# Edit .env with your configuration

Development

Run all applications in development mode:

pnpm dev

Run specific workspace:

pnpm --filter web dev
pnpm --filter api dev
pnpm --filter admin dev

Building

Build all applications:

pnpm build

Build specific workspace:

pnpm --filter web build

Testing

Run tests across all workspaces:

pnpm test

Linting

Check code quality:

pnpm lint

Type checking:

pnpm typecheck

Core Entities

User

Roles: fan, artist, admin
Owns one profile
Authentication and authorization

ArtistProfile

Public identity for performers
Stage name, bio, genres, wallet address
Referenced by sessions and tips

Session

Lifecycle: draft → live → ended
Connected to one artist
Contains stream metadata and viewer count

TipIntent

Client-created draft for payment preparation
Becomes payment-ready transaction
Links fan to artist session

AuditEvent

Emitted for successful mutations
Queried by admin surfaces
Tracks system activity

API Routes

Authentication

POST /auth/register - Create new user account
POST /auth/login - Authenticate user
GET /auth/session - Verify session

Profile

POST /profile - Create artist profile
PATCH /profile/:id - Update profile
GET /profile/:slug - Get public profile

Sessions

POST /sessions - Create session draft
PATCH /sessions/:id - Update session
POST /sessions/:id/start - Start live session
POST /sessions/:id/end - End session
GET /sessions/live - List live sessions

Payments

POST /payments/prepare - Prepare tip transaction
POST /payments/confirm - Confirm transaction

Audit

GET /audit - Query audit events (admin only)

Web Routes

Public

/ - Landing page
/discover - Browse live performances
/sessions/:slug - Session detail and tip form

Artist

/artist/onboarding - Artist setup
/artist/dashboard - Session controls
/profile - Profile editing

Admin

/admin/login - Admin authentication
/admin - Admin dashboard

Contributing

We welcome contributions from the community! Here's how you can help:

Ways to Contribute

Report Bugs: Open an issue describing the bug and how to reproduce it
Suggest Features: Share your ideas for new features or improvements
Submit Pull Requests: Fix bugs or implement features
Improve Documentation: Help make our docs clearer and more comprehensive
Code Review: Review open pull requests

Development Workflow

Fork the repository to your GitHub account
Clone your fork:

git clone https://github.com/yourusername/Stellar-Polyphony.git
cd Stellar-Polyphony

Create a feature branch:

git checkout -b feature/your-feature-name

Install dependencies:

pnpm install

Make your changes:
- Write clean, readable code
- Follow existing code style
- Add tests for new features
- Update documentation as needed
Test your changes:

pnpm lint
pnpm typecheck
pnpm test
pnpm build

Commit your changes:

git add .
git commit -m "feat: add your feature description"

Follow Conventional Commits:

feat: - New feature
fix: - Bug fix
docs: - Documentation changes
style: - Code style changes (formatting, etc.)
refactor: - Code refactoring
test: - Adding or updating tests
chore: - Maintenance tasks

Push to your fork:

git push origin feature/your-feature-name

Open a Pull Request:
- Go to the original repository
- Click "New Pull Request"
- Select your fork and branch
- Fill out the PR template
- Link any related issues

Code Style Guidelines

Use TypeScript for all new code
Follow ESLint rules configured in the project
Use Prettier for code formatting
Write meaningful variable and function names
Add JSDoc comments for public APIs
Keep functions small and focused
Write unit tests for business logic

Pull Request Guidelines

One feature per PR: Keep PRs focused and manageable
Update documentation: Include relevant doc updates
Add tests: Ensure new code is tested
Pass CI checks: All tests and lints must pass
Descriptive title: Clearly describe what the PR does
Link issues: Reference related issues in the description
Request review: Tag relevant maintainers

Branch Naming Convention

feature/ - New features
fix/ - Bug fixes
docs/ - Documentation updates
refactor/ - Code refactoring
test/ - Test additions or updates

Testing Requirements

Unit tests for utility functions and business logic
Integration tests for API endpoints
Component tests for UI components
Maintain or improve code coverage

Documentation Standards

Update README.md for user-facing changes
Add JSDoc comments for functions and classes
Update API documentation for endpoint changes
Include examples in documentation
Keep docs in sync with code

Getting Help

Discord: Join our community server (link coming soon)
Issues: Ask questions by opening an issue with the "question" label
Discussions: Use GitHub Discussions for broader topics

Code of Conduct

Be respectful and inclusive
Welcome newcomers
Focus on constructive feedback
Assume good intentions
Follow the Contributor Covenant

Recognition

Contributors will be:

Listed in our CONTRIBUTORS.md file
Mentioned in release notes for significant contributions
Invited to join the core team for sustained contributions

Development Phases

Phase 1 (Current)

Basic authentication and user management
Artist profile creation and editing
Session lifecycle management
Discovery and session detail pages
Mock payment preparation
Admin audit logging

Phase 2 (Planned)

Real Stellar blockchain integration
Live streaming infrastructure
Real-time chat and interactions
Advanced search and filtering
Mobile applications
Analytics dashboard

Technology Stack

Frontend

React / Next.js
TypeScript
Tailwind CSS
React Query

Backend

Node.js
Express / Fastify
TypeScript
PostgreSQL
Redis

Blockchain

Stellar SDK
Wallet integration

Infrastructure

Docker
GitHub Actions
Vercel / AWS

License

MIT License - see LICENSE file for details

Links

Documentation: docs/
Architecture: docs/architecture.md
API Reference: docs/api-reference.md
Contributing Guide: This README (Contributing section)
Code of Conduct: CODE_OF_CONDUCT.md

Support

Issues: GitHub Issues
Discussions: GitHub Discussions
Email: support@stellar-polyphony.com

Built with ❤️ by the Stellar-Polyphony community

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
apps		apps
docs		docs
packages		packages
.env.example		.env.example
.gitignore		.gitignore
.prettierrc.json		.prettierrc.json
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
COMPARISON.md		COMPARISON.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS.md		CONTRIBUTORS.md
LICENSE		LICENSE
PROJECT_SUMMARY.md		PROJECT_SUMMARY.md
QUICKSTART.md		QUICKSTART.md
README.md		README.md
eslint.config.mjs		eslint.config.mjs
package.json		package.json
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.json		tsconfig.json
turbo.json		turbo.json

Folders and files

Latest commit

History

Repository files navigation

Stellar-Polyphony

Overview

Key Features

Architecture

Project Structure

Getting Started

Prerequisites

Installation

Development

Building

Testing

Linting

Core Entities

User

ArtistProfile

Session

TipIntent

AuditEvent

API Routes

Authentication

Profile

Sessions

Payments

Audit

Web Routes

Public

Artist

Admin

Contributing

Ways to Contribute

Development Workflow

Code Style Guidelines

Pull Request Guidelines

Branch Naming Convention

Testing Requirements

Documentation Standards

Getting Help

Code of Conduct

Recognition

Development Phases

Phase 1 (Current)

Phase 2 (Planned)

Technology Stack

Frontend

Backend

Blockchain

Infrastructure

License

Links

Support

About

Resources

License

Code of conduct

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages