Skip to content

toplocs/toplocs-workspace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

80 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TopLocs Workspace

Ecosystem setup for the TopLocs decentralized P2P community platform

This repository orchestrates the entire TopLocs development environment through AI automation.

🚀 New Developer? AI Setup in 30 Seconds!

Quick Start

git clone git@github.com:toplocs/toplocs-workspace.git toplocs
cd toplocs && claude

Then use this prompt:

I just cloned the toplocs-workspace repository. Please help me set up the complete TopLocs ecosystem by reading the documentation, cloning all repositories, and setting up the development environment. I want to work on: [your goals]

👉 Complete Getting Started Guide

📁 What This Workspace Provides

toplocs-workspace/ (this repository)
├── README.md           # Quick start guide  
├── CLAUDE.md          # Comprehensive AI context
├── docs/              # Setup guides & documentation
├── docusaurus/        # 📚 Documentation site (Docusaurus)
└── .gitignore         # Excludes auto-cloned repos

Auto-cloned repositories (after AI setup):
├── tribelike/         # ⭐ Core P2P platform
├── locations/         # Mobile app (Ionic)
├── *-plugin/          # Plugin repositories
└── [others]           # Development tools & docs

📚 Documentation Hub

Live Documentation: https://toplocs.github.io/toplocs-workspace/

The docusaurus/ folder contains our centralized documentation site that aggregates docs from all TopLocs repositories.

  • Local Development: cd docusaurus && pnpm start
  • Auto-deploys: Via GitHub Actions on push to main
  • Multi-source: Pulls docs from workspace, tribelike, and plugins

Learn more about the documentation system →

🎯 Why AI-Driven Setup?

Traditional Approach Problems

  • ❌ Complex multi-repo setup
  • ❌ Outdated documentation
  • ❌ Inconsistent environments
  • ❌ Hours of configuration

AI-Driven Approach Benefits

  • 30-second setup: AI handles everything
  • Always current: AI reads latest documentation
  • Consistent environments: Same setup for everyone
  • Intelligent guidance: AI understands your goals

🏗️ Architecture Overview

TopLocs is a decentralized P2P community platform built on Gun.js:

  • No Central Server: Data distributed across peers
  • User-Owned Data: Cryptographic keys ensure control
  • Offline-First: Works without internet
  • Plugin-Based: Extensible through Module Federation
  • Real-Time Sync: Instant updates between peers

🤖 AI Development Features

Automated Setup

  • Clone all repositories from GitHub
  • Install dependencies and configure environments
  • Provide ecosystem context and guidance

Development Assistance

  • Cross-repository coordination
  • Architecture guidance for P2P patterns
  • Plugin development with Module Federation
  • P2P migration assistance for legacy code

Documentation Maintenance

  • Keep docs synchronized across repos
  • Update AI context as ecosystem evolves
  • Maintain getting-started guides
  • Simplified GitHub Actions (deploy docs only)
  • Manual sync workflow for repository analysis and documentation updates

📚 Centralized Documentation Hub

Workspace Documentation (This Repository)

Project Documentation (Centralized)

🚀 Next Steps

For New Developers

  1. Use the AI setup prompt above
  2. Follow AI guidance for your specific goals
  3. Start building amazing P2P features!

For Team Members

  1. Clone this workspace
  2. Let AI coordinate your development environment
  3. Focus on innovation, not configuration

🤝 Contributing

This workspace approach enables:

  • Consistent onboarding for all contributors
  • AI-guided development with full ecosystem context
  • Simplified coordination across multiple repositories
  • Focus on building rather than setup complexity

📄 License & Community

Open Source: MIT License
Community: Building the future of decentralized social platforms
Contributions: Always welcome - AI will help you get started!


Ready to build the future? Use the AI setup prompt and start contributing to decentralized communities! 🚀

About

AI-driven workspace for TopLocs ecosystem setup and development coordination

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5