Awesome LUMOS ✨

Write once. Deploy Everywhere.

Curated collection of awesome LUMOS examples, full-stack applications, tutorials, and community projects for Solana development.

What is LUMOS?

LUMOS is a type-safe schema language and code generator that bridges TypeScript and Rust for Solana development.

The Problem: Building full-stack Solana apps requires maintaining identical type definitions in both Rust (programs) and TypeScript (clients). Manual synchronization is error-prone and time-consuming.

The Solution: Write your data structures once in .lumos syntax, and LUMOS automatically generates production-ready code for both languages with guaranteed Borsh serialization compatibility.

Stop writing the same types twice. Start building faster.

---

📚 Contents

• Official Resources
• Getting Started
• Full-Stack Examples
• Tutorials
• Templates & Starters
• Community Projects
• Tools & Utilities
• Contributing

---

🎯 Official Resources

• LUMOS Repository - Core library and CLI
• VSCode Extension - Syntax highlighting and snippets
• Documentation - Official documentation
• Examples - Schema examples in main repo

---

🚀 Getting Started

Installation

# Install LUMOS CLI
cargo install lumos-cli

# Verify installation
lumos --version

# Install VSCode extension (optional)
# Search for "LUMOS" in VSCode Extensions

Quick Example

#[solana]
#[account]
struct UserAccount {
    wallet: PublicKey,
    balance: u64,
    level: u16,
}

Generate code:

lumos generate schema.lumos

---

🏗️ Full-Stack Examples

Coming Soon! Full-stack Solana applications built with LUMOS.

Planned Examples

• NFT Marketplace - Complete NFT marketplace with listings, bidding, and sales
• DeFi Staking Platform - Token staking with rewards calculation
• DAO Governance - Proposal creation, voting, and execution
• Gaming Platform - On-chain game state and player progression
• Token Vesting - Time-locked token release schedules

Want to contribute? See Contributing section below!

---

📖 Tutorials

Coming Soon! Step-by-step tutorials for building Solana applications with LUMOS.

Planned Tutorials

• Your First LUMOS Project
• Building an NFT Minting Program
• Creating a Token Staking Pool
• Implementing DAO Governance
• Advanced Type Patterns with Enums
• Testing LUMOS-Generated Code

---

🎨 Templates & Starters

Anchor Program Template

# Coming soon - scaffold a new Anchor program with LUMOS
lumos new --template anchor my-program

Full-Stack DApp Template

# Coming soon - scaffold a complete DApp (Anchor + React + LUMOS)
lumos new --template dapp my-dapp

---

🌟 Community Projects

Showcase your LUMOS project here!

Built something awesome with LUMOS? Submit a PR to add it here:

• Your Project - Brief description and link

---

🛠️ Tools & Utilities

Official Tools

• LUMOS CLI - Code generation tool
• VSCode Extension - Syntax highlighting and snippets

Community Tools

Coming Soon! Community-contributed tools and utilities.

---

🤝 Contributing

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

Adding Your Project

1. Fork this repository
2. Add your project to the appropriate section
3. Follow the format: **Project Name** - Brief description ([Demo](link) | [Source](link))
4. Submit a pull request

Creating Examples

We're looking for:

• ✨ Full-stack Solana applications using LUMOS
• 📚 Tutorial content and guides
• 🎨 Starter templates and boilerplates
• 🔧 Tools and utilities that enhance LUMOS development

Requirements for examples:

• Complete, working code
• README with setup instructions
• Well-documented and commented
• Follows LUMOS best practices

Example Contribution Template

examples/
└── your-project/
    ├── README.md           (Setup, features, architecture)
    ├── schema.lumos        (LUMOS schema definitions)
    ├── programs/           (Anchor/Solana programs)
    ├── app/                (Frontend application)
    └── tests/              (Integration tests)

---

📋 Contribution Guidelines

1. Quality Over Quantity - Each example should be production-quality
2. Documentation - Include comprehensive README and inline comments
3. Testing - All examples must include tests
4. License - Use MIT or Apache 2.0 license
5. Maintenance - Be responsive to issues and keep examples updated

---

📄 License

This repository is dual-licensed under:

• Apache License, Version 2.0 (LICENSE-APACHE)
• MIT License (LICENSE-MIT)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion shall be dual licensed as above, without any additional terms or conditions.

---

🙏 Acknowledgments

• LUMOS Team - For creating an amazing tool
• Solana Foundation - For the incredible blockchain ecosystem
• Anchor Team - For the excellent Solana development framework
• Contributors - Everyone who contributes examples and improvements

---