Quick Start: Your First Ring Clone
Time Estimate: 30 minutes | Prerequisites: Git, Node.js 18+, basic command line knowledge
This guide will take you from zero to a deployed Ring platform. By the end, you'll have your own branded platform running in production.
Before You Start
What you'll need:
- Git installed
- Node.js 18 or higher
- A code editor (VS Code recommended)
- Optional: Docker for containerized deployment
What you'll get:
- Fully functional Ring platform
- 20+ integrated modules
- AI-powered opportunity matching
- Multi-vendor marketplace
- Wallet with RING token support
- Production-ready deployment
Step 1: Clone the Repository
Open your terminal and clone the Ring platform:
git clone https://github.com/connectplatform/ring-platform.git
cd ring-platformInstall dependencies:
npm installStart the development server:
npm run devOpen http://localhost:3000 in your browser. You should see your Ring platform running locally!
Step 2: Basic Configuration
Create environment file:
Copy the example environment file:
# cp .env.example .env.localConfigure your platform:
Edit .env.local with your settings:
Your platform name Your domain (for production) Choose your database (start with Firebase for simplicity)
NEXT_PUBLIC_APP_NAME="My Ring Platform"
NEXT_PUBLIC_APP_URL="https://myplatform.com"
DATABASE_MODE=firebase_onlySet up authentication:
For rapid prototyping, Ring comes with Google authentication pre-configured. Add your Google OAuth credentials to .env.local:
GOOGLE_CLIENT_SECRET=your_google_client_secretStep 3: Customize Branding
Update platform name and description:
Edit lib/config/site.ts:
name: "My Platform Name",
description: "Solving [your mission] collectively with AI",
url: "https://myplatform.com",
}Customize colors and theme:
Edit tailwind.config.js to match your brand:
extend: {
colors: {
primary: {
50: '#your-brand-color-50',
// ... add your brand colors
}
}
}
}Add your logo:
Replace logo files in public/ directory:
logo.svg- main logofavicon.ico- browser favicon
Step 4: Deploy to Production
Choose deployment method:
Option A: Vercel (Recommended for beginners)
npm i -g vercel
vercel --prodOption B: Docker
docker build -t my-ring-platform .
docker run -p 3000:3000 my-ring-platformOption C: Traditional hosting
npm run build
npm startConfigure production environment:
Set production environment variables in your hosting platform:
NODE_ENV=productionNEXT_PUBLIC_APP_URL=https://yourdomain.com- Database connection strings
Set up domain:
Point your domain to your deployment and update DNS records as needed.
Step 5: Enable Core Features
Enable user registration:
Ring comes with authentication ready. Users can sign up with Google or email.
Set up your first entity types:
Go to /admin/entities to configure what types of organizations use your platform (companies, cooperatives, nonprofits, etc.)
Configure opportunity categories:
Define what types of opportunities your users can post (projects, partnerships, services, etc.)
Enable marketplace features:
Configure store categories and payment methods for your marketplace.
Step 6: Go Live!
Test everything works:
- User registration and login ✓
- Creating entities and opportunities ✓
- Posting to marketplace ✓
- Basic navigation ✓
Invite your first users:
Share your platform URL and start building your community.
Monitor and optimize:
Use Ring's built-in analytics to track usage and optimize your platform.
What's Next?
Congratulations! You now have a production Ring platform. Here are your next steps:
Immediate (Week 1)
- Invite 5-10 users for feedback
- Customize remaining branding elements
- Set up payment processing
- Configure AI matching preferences
Short-term (Month 1)
- Complete customization guide for advanced branding
- Database migration if you need PostgreSQL
- Token economics setup for your own RING token
- Payment integration for monetization
Long-term (Months 2-6)
- AI customization for specialized matching
- Multi-tenant deployment for scaling
- Custom module development
- Advanced integrations
Need Help?
- Stuck? Check our troubleshooting guide
- Community Join our developer community
- Professional help Post on Ring customization opportunities
Pro tip: Start simple, then add complexity. Most successful Ring deployments begin with core features and gradually enable advanced modules as their community grows.