Scanning documentation library
Scanning documentation library
Scanning documentation library
This comprehensive guide covers all requirements for setting up Ring Platform for development and production deployment. Ring Platform is built with modern web technologies and requires specific system configurations for optimal performance.
15-30 minutes for complete setup, depending on your experience level and internet connection.
| Component | Development | Production |
|---|---|---|
| CPU | 4 cores (Intel i5/AMD Ryzen 5) | 8+ cores (Intel i7/AMD Ryzen 7) |
| RAM | 8GB | 16GB+ |
| Storage | 10GB free space | 50GB+ SSD |
| Network | 10 Mbps | 100 Mbps+ |
While Ring Platform works on Windows with WSL2, we recommend using Linux or macOS for the best development experience. Some features may have limited Windows support.
Ring Platform requires Node.js 18.17+ and npm 8.19+ (or equivalent package managers).
Check current versions
macOS/Linux with nvm:
Install nvm:
Restart terminal or run:
Install and use Node.js 18:
Windows with nvm-windows:
Download and install from https://github.com/coreybutler/nvm-windows/releases
Then install Node.js 18:
Download from nodejs.org and install Node.js 18 LTS.
macOS with Homebrew:
Ubuntu/Debian:
Configure npm for better performance Optional: Use yarn for faster installs
Ring Platform supports multiple database backends with PostgreSQL as the primary recommendation.
macOS with Homebrew: Create database
Ubuntu/Debian: Start service Create database
Docker (Cross-platform): Run PostgreSQL in Docker:
For persistent data:
While Firebase is still supported for compatibility, PostgreSQL is strongly recommended for new deployments.
Ring Platform uses Auth.js v5 with multiple OAuth providers for secure authentication.
Create Google Cloud Project
Enable Google+ API
Create OAuth Credentials
http://localhost:3000 (development)https://yourdomain.com (production)http://localhost:3000/api/auth/callback/googlehttps://yourdomain.com/api/auth/callback/googleGet Client ID and Secret
Required for iOS app integration:
Apple Developer Account
Create App ID
Create Service ID
Generate Private Key
.p8 file (keep secure!)For blockchain features including NFT marketplace and RING token operations.
Install MetaMask browser extension:
Visit: https://metamask.io/download/
Or install via package manager:
macOS/Linux:
Download from official website
Generate a secure encryption key for wallet operations:
Generate 256-bit (32-byte) hex key Example output: a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcdef
Required for store checkout and premium features.
Create Merchant Account
Get API Credentials
Configure Payment Methods
Install Git (if not already installed):
Install development dependencies:
Optional: Install VS Code extensions:
Visual Studio Code with these extensions:
ms-vscode.vscode-typescript-nextbradlc.vscode-tailwindcssesbenp.prettier-vscodedbaeumer.vscode-eslintms-vscode.vscode-jsonCreate .env.local from the provided template:
Never commit sensitive data to version control:
.env.local (development - keep local) .env.production (production - set via deployment platform) Same variables but with production values
Secure environment files Secure private keys
Run these commands to verify your setup:
Check Node.js and npm:
Check system resources:
Check network connectivity:
PostgreSQL: Test connection Or with Docker
Firebase (if using): Check Firebase CLI:
Login to Firebase:
Test Google OAuth credentials format:
Test Apple credentials (if using):
Validate URLs are accessible:
Check wallet encryption key format:
Test MetaMask installation (manual):
Open browser and check for MetaMask extension:
If you see "Node.js version not supported":
PostgreSQL: Check if PostgreSQL is running:
Reset PostgreSQL password:
Firebase: Re-authenticate Firebase Check project access
Test connectivity to required services Check DNS resolution Test on different network if issues persist
Once all prerequisites are met:
.env.local setupIf all validations pass, you're ready to install Ring Platform! Head to the Installation Guide to get started.
Need help with setup? Join our Discord Community for support.
This comprehensive guide covers all requirements for setting up Ring Platform for development and production deployment. Ring Platform is built with modern web technologies and requires specific system configurations for optimal performance.
15-30 minutes for complete setup, depending on your experience level and internet connection.
| Component | Development | Production |
|---|---|---|
| CPU | 4 cores (Intel i5/AMD Ryzen 5) | 8+ cores (Intel i7/AMD Ryzen 7) |
| RAM | 8GB | 16GB+ |
| Storage | 10GB free space | 50GB+ SSD |
| Network | 10 Mbps | 100 Mbps+ |
While Ring Platform works on Windows with WSL2, we recommend using Linux or macOS for the best development experience. Some features may have limited Windows support.
Ring Platform requires Node.js 18.17+ and npm 8.19+ (or equivalent package managers).
Check current versions
macOS/Linux with nvm:
Install nvm:
Restart terminal or run:
Install and use Node.js 18:
Windows with nvm-windows:
Download and install from https://github.com/coreybutler/nvm-windows/releases
Then install Node.js 18:
Download from nodejs.org and install Node.js 18 LTS.
macOS with Homebrew:
Ubuntu/Debian:
Configure npm for better performance Optional: Use yarn for faster installs
Ring Platform supports multiple database backends with PostgreSQL as the primary recommendation.
macOS with Homebrew: Create database
Ubuntu/Debian: Start service Create database
Docker (Cross-platform): Run PostgreSQL in Docker:
For persistent data:
While Firebase is still supported for compatibility, PostgreSQL is strongly recommended for new deployments.
Ring Platform uses Auth.js v5 with multiple OAuth providers for secure authentication.
Create Google Cloud Project
Enable Google+ API
Create OAuth Credentials
http://localhost:3000 (development)https://yourdomain.com (production)http://localhost:3000/api/auth/callback/googlehttps://yourdomain.com/api/auth/callback/googleGet Client ID and Secret
Required for iOS app integration:
Apple Developer Account
Create App ID
Create Service ID
Generate Private Key
.p8 file (keep secure!)For blockchain features including NFT marketplace and RING token operations.
Install MetaMask browser extension:
Visit: https://metamask.io/download/
Or install via package manager:
macOS/Linux:
Download from official website
Generate a secure encryption key for wallet operations:
Generate 256-bit (32-byte) hex key Example output: a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcdef
Required for store checkout and premium features.
Create Merchant Account
Get API Credentials
Configure Payment Methods
Install Git (if not already installed):
Install development dependencies:
Optional: Install VS Code extensions:
Visual Studio Code with these extensions:
ms-vscode.vscode-typescript-nextbradlc.vscode-tailwindcssesbenp.prettier-vscodedbaeumer.vscode-eslintms-vscode.vscode-jsonCreate .env.local from the provided template:
Never commit sensitive data to version control:
.env.local (development - keep local) .env.production (production - set via deployment platform) Same variables but with production values
Secure environment files Secure private keys
Run these commands to verify your setup:
Check Node.js and npm:
Check system resources:
Check network connectivity:
PostgreSQL: Test connection Or with Docker
Firebase (if using): Check Firebase CLI:
Login to Firebase:
Test Google OAuth credentials format:
Test Apple credentials (if using):
Validate URLs are accessible:
Check wallet encryption key format:
Test MetaMask installation (manual):
Open browser and check for MetaMask extension:
If you see "Node.js version not supported":
PostgreSQL: Check if PostgreSQL is running:
Reset PostgreSQL password:
Firebase: Re-authenticate Firebase Check project access
Test connectivity to required services Check DNS resolution Test on different network if issues persist
Once all prerequisites are met:
.env.local setupIf all validations pass, you're ready to install Ring Platform! Head to the Installation Guide to get started.
Need help with setup? Join our Discord Community for support.
This comprehensive guide covers all requirements for setting up Ring Platform for development and production deployment. Ring Platform is built with modern web technologies and requires specific system configurations for optimal performance.
15-30 minutes for complete setup, depending on your experience level and internet connection.
| Component | Development | Production |
|---|---|---|
| CPU | 4 cores (Intel i5/AMD Ryzen 5) | 8+ cores (Intel i7/AMD Ryzen 7) |
| RAM | 8GB | 16GB+ |
| Storage | 10GB free space | 50GB+ SSD |
| Network | 10 Mbps | 100 Mbps+ |
While Ring Platform works on Windows with WSL2, we recommend using Linux or macOS for the best development experience. Some features may have limited Windows support.
Ring Platform requires Node.js 18.17+ and npm 8.19+ (or equivalent package managers).
Check current versions
macOS/Linux with nvm:
Install nvm:
Restart terminal or run:
Install and use Node.js 18:
Windows with nvm-windows:
Download and install from https://github.com/coreybutler/nvm-windows/releases
Then install Node.js 18:
Download from nodejs.org and install Node.js 18 LTS.
macOS with Homebrew:
Ubuntu/Debian:
Configure npm for better performance Optional: Use yarn for faster installs
Ring Platform supports multiple database backends with PostgreSQL as the primary recommendation.
macOS with Homebrew: Create database
Ubuntu/Debian: Start service Create database
Docker (Cross-platform): Run PostgreSQL in Docker:
For persistent data:
While Firebase is still supported for compatibility, PostgreSQL is strongly recommended for new deployments.
Ring Platform uses Auth.js v5 with multiple OAuth providers for secure authentication.
Create Google Cloud Project
Enable Google+ API
Create OAuth Credentials
http://localhost:3000 (development)https://yourdomain.com (production)http://localhost:3000/api/auth/callback/googlehttps://yourdomain.com/api/auth/callback/googleGet Client ID and Secret
Required for iOS app integration:
Apple Developer Account
Create App ID
Create Service ID
Generate Private Key
.p8 file (keep secure!)For blockchain features including NFT marketplace and RING token operations.
Install MetaMask browser extension:
Visit: https://metamask.io/download/
Or install via package manager:
macOS/Linux:
Download from official website
Generate a secure encryption key for wallet operations:
Generate 256-bit (32-byte) hex key Example output: a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcdef
Required for store checkout and premium features.
Create Merchant Account
Get API Credentials
Configure Payment Methods
Install Git (if not already installed):
Install development dependencies:
Optional: Install VS Code extensions:
Visual Studio Code with these extensions:
ms-vscode.vscode-typescript-nextbradlc.vscode-tailwindcssesbenp.prettier-vscodedbaeumer.vscode-eslintms-vscode.vscode-jsonCreate .env.local from the provided template:
Never commit sensitive data to version control:
.env.local (development - keep local) .env.production (production - set via deployment platform) Same variables but with production values
Secure environment files Secure private keys
Run these commands to verify your setup:
Check Node.js and npm:
Check system resources:
Check network connectivity:
PostgreSQL: Test connection Or with Docker
Firebase (if using): Check Firebase CLI:
Login to Firebase:
Test Google OAuth credentials format:
Test Apple credentials (if using):
Validate URLs are accessible:
Check wallet encryption key format:
Test MetaMask installation (manual):
Open browser and check for MetaMask extension:
If you see "Node.js version not supported":
PostgreSQL: Check if PostgreSQL is running:
Reset PostgreSQL password:
Firebase: Re-authenticate Firebase Check project access
Test connectivity to required services Check DNS resolution Test on different network if issues persist
Once all prerequisites are met:
.env.local setupIf all validations pass, you're ready to install Ring Platform! Head to the Installation Guide to get started.
Need help with setup? Join our Discord Community for support.