Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.91 KB

File metadata and controls

55 lines (37 loc) · 1.91 KB

Getting Started

Welcome to CycleStark! This section will help you get up and running with the platform, whether you're a user wanting to participate in collectives or a developer looking to contribute to the project.

🎯 Choose Your Path

👤 For Users

If you want to use CycleStark to participate in collectives and funding cycles:

  1. Installation Guide - Set up your environment
  2. Quick Start - Get started in minutes
  3. User Guide - Learn how to use the platform

👨‍💻 For Developers

If you want to contribute to the project or run it locally:

  1. Development Setup - Set up your development environment
  2. Developer Guide - Learn about the codebase
  3. Architecture - Understand the system design

🚀 Quick Overview

CycleStark consists of three main components:

  1. Smart Contracts - Cairo contracts deployed on Starknet
  2. Frontend Application - React-based web interface
  3. Blockchain Infrastructure - Madara app chain for development

📋 Prerequisites

Before you begin, make sure you have:

  • For Users: A Starknet-compatible wallet (ArgentX, Braavos, etc.)
  • For Developers:
    • Node.js (v18+)
    • Rust (latest stable)
    • Cairo toolchain
    • Git

🔗 Next Steps

Choose the appropriate guide based on your needs:

❓ Need Help?

If you encounter any issues:

  1. Check the FAQ
  2. Search existing issues
  3. Join our Discord community
  4. Create a new issue with detailed information