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.

⏱️ Estimated Setup Time

15-30 minutes for complete setup, depending on your experience level and internet connection.

🖥️ System Requirements

Minimum Hardware Requirements

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+

Supported Operating Systems

macOS: 12.0+ (Monterey or later)
Linux: Ubuntu 20.04+, CentOS 8+, Debian 11+
Windows: 10/11 with WSL2 (Windows Subsystem for Linux)
Docker: For containerized development and deployment

Windows Users

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.

🟢 Node.js & Package Management

Required Versions

Ring Platform requires Node.js 18.17+ and npm 8.19+ (or equivalent package managers).

Check current versions

terminal

bash

node --version    # Should show v18.17.0 or higher
npm --version     # Should show 8.19.0 or higher

Recommended Setup

Option 1: Node Version Manager (Recommended)

macOS/Linux with nvm:

Install nvm:

terminal

bash

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

Restart terminal or run:

terminal

bash

source ~/.bashrc

Install and use Node.js 18:

terminal

bash

nvm install 18
nvm use 18
nvm alias default 18

Windows with nvm-windows:

Download and install from https://github.com/coreybutler/nvm-windows/releases

Then install Node.js 18:

terminal

powershell

nvm install 18
nvm use 18

Option 2: Official Installers

Download from nodejs.org and install Node.js 18 LTS.

Option 3: Package Managers

macOS with Homebrew:

terminal

bash

brew install node@18
brew link node@18

Ubuntu/Debian:

terminal

bash

curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs

Package Manager Configuration

Configure npm for better performance Optional: Use yarn for faster installs

terminal

bash

npm config set fund false
npm config set audit false

npm install -g yarn

🗄️ Database Setup

Ring Platform supports multiple database backends with PostgreSQL as the primary recommendation.

Option 1: PostgreSQL (Recommended for Production)

Local Development Setup

macOS with Homebrew: Create database

terminal

bash

brew install postgresql@15
brew services start postgresql@15

createdb ring_platform

Ubuntu/Debian: Start service Create database

terminal

bash

sudo apt update
sudo apt install postgresql postgresql-contrib

sudo systemctl start postgresql
sudo systemctl enable postgresql

sudo -u postgres createdb ring_platform

Docker (Cross-platform): Run PostgreSQL in Docker:

For persistent data:

terminal

bash

docker run --name ring-postgres -e POSTGRES_DB=ring_platform -e POSTGRES_USER=ring_user -e POSTGRES_PASSWORD=your_password -p 5432:5432 -d postgres:15

docker run --name ring-postgres -e POSTGRES_DB=ring_platform -e POSTGRES_USER=ring_user -e POSTGRES_PASSWORD=your_password -v ring_data:/var/lib/postgresql/data -p 5432:5432 -d postgres:15

Cloud PostgreSQL Options

Supabase: Managed PostgreSQL with real-time features
Neon: Serverless PostgreSQL
AWS RDS: Enterprise PostgreSQL hosting
Google Cloud SQL: Managed PostgreSQL service
Azure Database: Microsoft PostgreSQL offering

Option 2: Firebase (Development/Legacy)

While Firebase is still supported for compatibility, PostgreSQL is strongly recommended for new deployments.

terminal

bash

# Firebase setup will be covered in environment configuration

🔐 Authentication Providers

Ring Platform uses Auth.js v5 with multiple OAuth providers for secure authentication.

Google OAuth Setup

Create Google Cloud Project
- Go to Google Cloud Console
- Create a new project or select existing one
Enable Google+ API
- Navigate to "APIs & Services" > "Library"
- Search for "Google+ API" and enable it
Create OAuth Credentials
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "OAuth 2.0 Client IDs"
- Choose "Web application"
- Add authorized origins:
  - http://localhost:3000 (development)
  - https://yourdomain.com (production)
- Add authorized redirect URIs:
  - http://localhost:3000/api/auth/callback/google
  - https://yourdomain.com/api/auth/callback/google
Get Client ID and Secret
- Copy the Client ID and Client Secret

Apple Sign-in Setup (Optional)

Required for iOS app integration:

Apple Developer Account
- Paid developer account ($99/year)
- Access to Apple Developer Portal
Create App ID
- Certificates, Identifiers & Profiles > Identifiers
- Create new App ID with Sign in with Apple capability
Create Service ID
- Create Services ID for web authentication
- Configure return URLs for your domain
Generate Private Key
- Create new key with Sign in with Apple capability
- Download the .p8 file (keep secure!)

Additional OAuth Providers (Optional)

GitHub: Developer-focused authentication
Discord: Community platform integration
Twitter/X: Social media authentication

🔑 Web3 Wallet Integration

For blockchain features including NFT marketplace and RING token operations.

MetaMask Setup

Install MetaMask browser extension:

Visit: https://metamask.io/download/

Or install via package manager:

macOS/Linux:

Download from official website

terminal

bash

brew install --cask metamask

Wallet Encryption Key

Generate a secure encryption key for wallet operations:

Generate 256-bit (32-byte) hex key Example output: a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcdef

terminal

bash

openssl rand -hex 32

💰 Payment Integration (WayForPay)

Required for store checkout and premium features.

WayForPay Account Setup

Create Merchant Account
- Visit WayForPay
- Register as a merchant
- Complete KYC verification
Get API Credentials
- Login to merchant dashboard
- Navigate to API settings
- Copy Merchant Account and Secret Key
Configure Payment Methods
- Enable card payments
- Configure Apple Pay / Google Pay
- Set up currency support (UAH, USD, EUR)

🛠️ Development Tools

Essential Tools

Install Git (if not already installed):

Install development dependencies:

Optional: Install VS Code extensions:

TypeScript and JavaScript Language Features
Tailwind CSS IntelliSense
Prettier - Code formatter
ESLint

terminal

bash

git --version

npm install -g typescript @types/node

Recommended IDE Setup

Visual Studio Code with these extensions:

ms-vscode.vscode-typescript-next
bradlc.vscode-tailwindcss
esbenp.prettier-vscode
dbaeumer.vscode-eslint
ms-vscode.vscode-json

Environment File Template

Create .env.local from the provided template:

terminal

bash

# cp .env.local.template .env.local

🌐 Network Requirements

Development

Internet Connection: Required for package installation and OAuth testing
Local Ports: 3000 (Next.js), 5432 (PostgreSQL)
Firewall: Allow outbound HTTPS connections

Production

SSL Certificate: Required for HTTPS (Let's Encrypt recommended)
Domain: Custom domain recommended
CDN: Optional but recommended for static assets
WebSocket Support: Required for real-time features

🔒 Security Considerations

Environment Variables

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

terminal

bash

AUTH_SECRET=your-auth-secret
AUTH_GOOGLE_ID=your-google-client-id
AUTH_GOOGLE_SECRET=your-google-client-secret
WALLET_ENCRYPTION_KEY=your-32-byte-hex-key

File Permissions

Secure environment files Secure private keys

terminal

bash

chmod 600 .env.local
chmod 600 .env.production

chmod 400 path/to/private-key.pem

🧪 Validation Checklist

Run these commands to verify your setup:

System Validation

Check Node.js and npm:

Check system resources:

Check network connectivity:

terminal

bash

node --version        # v18.17.0+
npm --version         # 8.19.0+

df -h                 # Disk space
free -h              # Memory (Linux)
vm_stat              # Memory (macOS)

curl -I https://registry.npmjs.org/

Database Validation

PostgreSQL: Test connection Or with Docker

terminal

bash

psql -h localhost -U ring_user -d ring_platform -c "SELECT version();"

docker exec -it ring-postgres psql -U ring_user -d ring_platform -c "SELECT 1;"

Firebase (if using): Check Firebase CLI:

terminal

bash

firebase --version

firebase login

OAuth Validation

Test Google OAuth credentials format:

Test Apple credentials (if using):

Validate URLs are accessible:

terminal

bash

echo $AUTH_GOOGLE_ID | grep -E "^[0-9]+-[a-zA-Z0-9_]+.apps.googleusercontent.com$"

echo $AUTH_APPLE_ID | grep -E "^com."

curl -s -o /dev/null -w "%{http_code}" https://accounts.google.com

Web3 Validation

Check wallet encryption key format:

Test MetaMask installation (manual):

Open browser and check for MetaMask extension:

terminal

bash

echo $WALLET_ENCRYPTION_KEY | grep -E "^[a-f0-9]{64}$"

🐛 Troubleshooting Common Issues

Node.js Version Issues

If you see "Node.js version not supported":

terminal

bash

nvm install 18
nvm use 18

# Clear npm cache
npm cache clean --force
rm -rf node_modules package-lock.json
npm install

Database Connection Issues

PostgreSQL: Check if PostgreSQL is running:

Reset PostgreSQL password:

terminal

bash

sudo systemctl status postgresql  # Linux
brew services list | grep postgresql  # macOS

sudo -u postgres psql
ALTER USER ring_user PASSWORD 'new_password';

Firebase: Re-authenticate Firebase Check project access

terminal

bash

firebase logout
firebase login

firebase projects:list

OAuth Configuration Issues

terminal

bash

# Google OAuth errors
# 1. Check authorized origins include your domain
# 2. Verify redirect URIs match exactly
# 3. Ensure Google+ API is enabled

# Apple Sign-in errors
# 1. Verify App ID and Service ID match
# 2. Check private key format and permissions
# 3. Validate return URLs in Apple Developer portal

Network and Firewall Issues

Test connectivity to required services Check DNS resolution Test on different network if issues persist

terminal

bash

curl -I https://accounts.google.com
curl -I https://api.github.com
curl -I https://registry.npmjs.org/

nslookup accounts.google.com

📚 Next Steps

Once all prerequisites are met:

Installation Guide - Clone and set up the project
Environment Configuration - Complete your .env.local setup
First Success Validation - Test your installation
Development Workflow - Start contributing

✅ Ready to Proceed

If 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.

Завантаження документації...

Підготовка контенту платформи Ring

Documentation

Getting Started

Architecture

Architecture Overview

Features

Security & Compliance

Token Staking

Performance

API Reference

CLI Tool

Ring CLI

Customization

Customization Overview

Deployment

Development

Examples

Third-party Integrations

Advanced Features

Real-world Use Cases

White Label

Quick Links

Empire Visualization Hub

Ringdom Maps

Get Started

Deployment Calculator

Become a SettlerRNG

Work & Community

Work OpportunitiesNew

Offline

Prerequisites

⏱️ Estimated Setup Time

15-30 minutes for complete setup, depending on your experience level and internet connection.

🖥️ System Requirements

Minimum Hardware Requirements

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+

Supported Operating Systems

macOS: 12.0+ (Monterey or later)
Linux: Ubuntu 20.04+, CentOS 8+, Debian 11+
Windows: 10/11 with WSL2 (Windows Subsystem for Linux)
Docker: For containerized development and deployment

Windows Users

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.

🟢 Node.js & Package Management

Required Versions

Ring Platform requires Node.js 18.17+ and npm 8.19+ (or equivalent package managers).

Check current versions

terminal

bash

node --version    # Should show v18.17.0 or higher
npm --version     # Should show 8.19.0 or higher

Recommended Setup

Option 1: Node Version Manager (Recommended)

macOS/Linux with nvm:

Install nvm:

terminal

bash

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

Restart terminal or run:

terminal

bash

source ~/.bashrc

Install and use Node.js 18:

terminal

bash

nvm install 18
nvm use 18
nvm alias default 18

Windows with nvm-windows:

Download and install from https://github.com/coreybutler/nvm-windows/releases

Then install Node.js 18:

terminal

powershell

nvm install 18
nvm use 18

Option 2: Official Installers

Download from nodejs.org and install Node.js 18 LTS.

Option 3: Package Managers

macOS with Homebrew:

terminal

bash

brew install node@18
brew link node@18

Ubuntu/Debian:

terminal

bash

curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs

Package Manager Configuration

Configure npm for better performance Optional: Use yarn for faster installs

terminal

bash

npm config set fund false
npm config set audit false

npm install -g yarn

🗄️ Database Setup

Ring Platform supports multiple database backends with PostgreSQL as the primary recommendation.

Option 1: PostgreSQL (Recommended for Production)

Local Development Setup

macOS with Homebrew: Create database

terminal

bash

brew install postgresql@15
brew services start postgresql@15

createdb ring_platform

Ubuntu/Debian: Start service Create database

terminal

bash

sudo apt update
sudo apt install postgresql postgresql-contrib

sudo systemctl start postgresql
sudo systemctl enable postgresql

sudo -u postgres createdb ring_platform

Docker (Cross-platform): Run PostgreSQL in Docker:

For persistent data:

terminal

bash

docker run --name ring-postgres -e POSTGRES_DB=ring_platform -e POSTGRES_USER=ring_user -e POSTGRES_PASSWORD=your_password -p 5432:5432 -d postgres:15

docker run --name ring-postgres -e POSTGRES_DB=ring_platform -e POSTGRES_USER=ring_user -e POSTGRES_PASSWORD=your_password -v ring_data:/var/lib/postgresql/data -p 5432:5432 -d postgres:15

Cloud PostgreSQL Options

Supabase: Managed PostgreSQL with real-time features
Neon: Serverless PostgreSQL
AWS RDS: Enterprise PostgreSQL hosting
Google Cloud SQL: Managed PostgreSQL service
Azure Database: Microsoft PostgreSQL offering

Option 2: Firebase (Development/Legacy)

While Firebase is still supported for compatibility, PostgreSQL is strongly recommended for new deployments.

terminal

bash

# Firebase setup will be covered in environment configuration

🔐 Authentication Providers

Ring Platform uses Auth.js v5 with multiple OAuth providers for secure authentication.

Google OAuth Setup

Create Google Cloud Project
- Go to Google Cloud Console
- Create a new project or select existing one
Enable Google+ API
- Navigate to "APIs & Services" > "Library"
- Search for "Google+ API" and enable it
Create OAuth Credentials
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "OAuth 2.0 Client IDs"
- Choose "Web application"
- Add authorized origins:
  - http://localhost:3000 (development)
  - https://yourdomain.com (production)
- Add authorized redirect URIs:
  - http://localhost:3000/api/auth/callback/google
  - https://yourdomain.com/api/auth/callback/google
Get Client ID and Secret
- Copy the Client ID and Client Secret

Apple Sign-in Setup (Optional)

Required for iOS app integration:

Apple Developer Account
- Paid developer account ($99/year)
- Access to Apple Developer Portal
Create App ID
- Certificates, Identifiers & Profiles > Identifiers
- Create new App ID with Sign in with Apple capability
Create Service ID
- Create Services ID for web authentication
- Configure return URLs for your domain
Generate Private Key
- Create new key with Sign in with Apple capability
- Download the .p8 file (keep secure!)

Additional OAuth Providers (Optional)

GitHub: Developer-focused authentication
Discord: Community platform integration
Twitter/X: Social media authentication

🔑 Web3 Wallet Integration

For blockchain features including NFT marketplace and RING token operations.

MetaMask Setup

Install MetaMask browser extension:

Visit: https://metamask.io/download/

Or install via package manager:

macOS/Linux:

Download from official website

terminal

bash

brew install --cask metamask

Wallet Encryption Key

Generate a secure encryption key for wallet operations:

Generate 256-bit (32-byte) hex key Example output: a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcdef

terminal

bash

openssl rand -hex 32

💰 Payment Integration (WayForPay)

Required for store checkout and premium features.

WayForPay Account Setup

Create Merchant Account
- Visit WayForPay
- Register as a merchant
- Complete KYC verification
Get API Credentials
- Login to merchant dashboard
- Navigate to API settings
- Copy Merchant Account and Secret Key
Configure Payment Methods
- Enable card payments
- Configure Apple Pay / Google Pay
- Set up currency support (UAH, USD, EUR)

🛠️ Development Tools

Essential Tools

Install Git (if not already installed):

Install development dependencies:

Optional: Install VS Code extensions:

TypeScript and JavaScript Language Features
Tailwind CSS IntelliSense
Prettier - Code formatter
ESLint

terminal

bash

git --version

npm install -g typescript @types/node

Recommended IDE Setup

Visual Studio Code with these extensions:

ms-vscode.vscode-typescript-next
bradlc.vscode-tailwindcss
esbenp.prettier-vscode
dbaeumer.vscode-eslint
ms-vscode.vscode-json

Environment File Template

Create .env.local from the provided template:

terminal

bash

# cp .env.local.template .env.local

🌐 Network Requirements

Development

Internet Connection: Required for package installation and OAuth testing
Local Ports: 3000 (Next.js), 5432 (PostgreSQL)
Firewall: Allow outbound HTTPS connections

Production

SSL Certificate: Required for HTTPS (Let's Encrypt recommended)
Domain: Custom domain recommended
CDN: Optional but recommended for static assets
WebSocket Support: Required for real-time features

🔒 Security Considerations

Environment Variables

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

terminal

bash

AUTH_SECRET=your-auth-secret
AUTH_GOOGLE_ID=your-google-client-id
AUTH_GOOGLE_SECRET=your-google-client-secret
WALLET_ENCRYPTION_KEY=your-32-byte-hex-key

File Permissions

Secure environment files Secure private keys

terminal

bash

chmod 600 .env.local
chmod 600 .env.production

chmod 400 path/to/private-key.pem

🧪 Validation Checklist

Run these commands to verify your setup:

System Validation

Check Node.js and npm:

Check system resources:

Check network connectivity:

terminal

bash

node --version        # v18.17.0+
npm --version         # 8.19.0+

df -h                 # Disk space
free -h              # Memory (Linux)
vm_stat              # Memory (macOS)

curl -I https://registry.npmjs.org/

Database Validation

PostgreSQL: Test connection Or with Docker

terminal

bash

psql -h localhost -U ring_user -d ring_platform -c "SELECT version();"

docker exec -it ring-postgres psql -U ring_user -d ring_platform -c "SELECT 1;"

Firebase (if using): Check Firebase CLI:

terminal

bash

firebase --version

firebase login

OAuth Validation

Test Google OAuth credentials format:

Test Apple credentials (if using):

Validate URLs are accessible:

terminal

bash

echo $AUTH_GOOGLE_ID | grep -E "^[0-9]+-[a-zA-Z0-9_]+.apps.googleusercontent.com$"

echo $AUTH_APPLE_ID | grep -E "^com."

curl -s -o /dev/null -w "%{http_code}" https://accounts.google.com

Web3 Validation

Check wallet encryption key format:

Test MetaMask installation (manual):

Open browser and check for MetaMask extension:

terminal

bash

echo $WALLET_ENCRYPTION_KEY | grep -E "^[a-f0-9]{64}$"

🐛 Troubleshooting Common Issues

Node.js Version Issues

If you see "Node.js version not supported":

terminal

bash

nvm install 18
nvm use 18

# Clear npm cache
npm cache clean --force
rm -rf node_modules package-lock.json
npm install

Database Connection Issues

PostgreSQL: Check if PostgreSQL is running:

Reset PostgreSQL password:

terminal

bash

sudo systemctl status postgresql  # Linux
brew services list | grep postgresql  # macOS

sudo -u postgres psql
ALTER USER ring_user PASSWORD 'new_password';

Firebase: Re-authenticate Firebase Check project access

terminal

bash

firebase logout
firebase login

firebase projects:list

OAuth Configuration Issues

terminal

bash

# Google OAuth errors
# 1. Check authorized origins include your domain
# 2. Verify redirect URIs match exactly
# 3. Ensure Google+ API is enabled

# Apple Sign-in errors
# 1. Verify App ID and Service ID match
# 2. Check private key format and permissions
# 3. Validate return URLs in Apple Developer portal

Network and Firewall Issues

Test connectivity to required services Check DNS resolution Test on different network if issues persist

terminal

bash

curl -I https://accounts.google.com
curl -I https://api.github.com
curl -I https://registry.npmjs.org/

nslookup accounts.google.com

📚 Next Steps

Once all prerequisites are met:

Installation Guide - Clone and set up the project
Environment Configuration - Complete your .env.local setup
First Success Validation - Test your installation
Development Workflow - Start contributing

✅ Ready to Proceed

If 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.

Завантаження документації...

Підготовка контенту платформи Ring

Documentation

Getting Started

Architecture

Architecture Overview

Features

Security & Compliance

Token Staking

Performance

API Reference

CLI Tool

Ring CLI

Customization

Customization Overview

Deployment

Development

Examples

Third-party Integrations

Advanced Features

Real-world Use Cases

White Label

Quick Links

Prerequisites

⏱️ Estimated Setup Time

15-30 minutes for complete setup, depending on your experience level and internet connection.

🖥️ System Requirements

Minimum Hardware Requirements

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+

Supported Operating Systems

macOS: 12.0+ (Monterey or later)
Linux: Ubuntu 20.04+, CentOS 8+, Debian 11+
Windows: 10/11 with WSL2 (Windows Subsystem for Linux)
Docker: For containerized development and deployment

Windows Users

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.

🟢 Node.js & Package Management

Required Versions

Ring Platform requires Node.js 18.17+ and npm 8.19+ (or equivalent package managers).

Check current versions

terminal

bash

node --version    # Should show v18.17.0 or higher
npm --version     # Should show 8.19.0 or higher

Recommended Setup

Option 1: Node Version Manager (Recommended)

macOS/Linux with nvm:

Install nvm:

terminal

bash

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

Restart terminal or run:

terminal

bash

source ~/.bashrc

Install and use Node.js 18:

terminal

bash

nvm install 18
nvm use 18
nvm alias default 18

Windows with nvm-windows:

Download and install from https://github.com/coreybutler/nvm-windows/releases

Then install Node.js 18:

terminal

powershell

nvm install 18
nvm use 18

Option 2: Official Installers

Download from nodejs.org and install Node.js 18 LTS.

Option 3: Package Managers

macOS with Homebrew:

terminal

bash

brew install node@18
brew link node@18

Ubuntu/Debian:

terminal

bash

curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs

Package Manager Configuration

Configure npm for better performance Optional: Use yarn for faster installs

terminal

bash

npm config set fund false
npm config set audit false

npm install -g yarn

🗄️ Database Setup

Ring Platform supports multiple database backends with PostgreSQL as the primary recommendation.

Option 1: PostgreSQL (Recommended for Production)

Local Development Setup

macOS with Homebrew: Create database

terminal

bash

brew install postgresql@15
brew services start postgresql@15

createdb ring_platform

Ubuntu/Debian: Start service Create database

terminal

bash

sudo apt update
sudo apt install postgresql postgresql-contrib

sudo systemctl start postgresql
sudo systemctl enable postgresql

sudo -u postgres createdb ring_platform

Docker (Cross-platform): Run PostgreSQL in Docker:

For persistent data:

terminal

bash

docker run --name ring-postgres -e POSTGRES_DB=ring_platform -e POSTGRES_USER=ring_user -e POSTGRES_PASSWORD=your_password -p 5432:5432 -d postgres:15

docker run --name ring-postgres -e POSTGRES_DB=ring_platform -e POSTGRES_USER=ring_user -e POSTGRES_PASSWORD=your_password -v ring_data:/var/lib/postgresql/data -p 5432:5432 -d postgres:15

Cloud PostgreSQL Options

Supabase: Managed PostgreSQL with real-time features
Neon: Serverless PostgreSQL
AWS RDS: Enterprise PostgreSQL hosting
Google Cloud SQL: Managed PostgreSQL service
Azure Database: Microsoft PostgreSQL offering

Option 2: Firebase (Development/Legacy)

While Firebase is still supported for compatibility, PostgreSQL is strongly recommended for new deployments.

terminal

bash

# Firebase setup will be covered in environment configuration

🔐 Authentication Providers

Ring Platform uses Auth.js v5 with multiple OAuth providers for secure authentication.

Google OAuth Setup

Create Google Cloud Project
- Go to Google Cloud Console
- Create a new project or select existing one
Enable Google+ API
- Navigate to "APIs & Services" > "Library"
- Search for "Google+ API" and enable it
Create OAuth Credentials
- Go to "APIs & Services" > "Credentials"
- Click "Create Credentials" > "OAuth 2.0 Client IDs"
- Choose "Web application"
- Add authorized origins:
  - http://localhost:3000 (development)
  - https://yourdomain.com (production)
- Add authorized redirect URIs:
  - http://localhost:3000/api/auth/callback/google
  - https://yourdomain.com/api/auth/callback/google
Get Client ID and Secret
- Copy the Client ID and Client Secret

Apple Sign-in Setup (Optional)

Required for iOS app integration:

Apple Developer Account
- Paid developer account ($99/year)
- Access to Apple Developer Portal
Create App ID
- Certificates, Identifiers & Profiles > Identifiers
- Create new App ID with Sign in with Apple capability
Create Service ID
- Create Services ID for web authentication
- Configure return URLs for your domain
Generate Private Key
- Create new key with Sign in with Apple capability
- Download the .p8 file (keep secure!)

Additional OAuth Providers (Optional)

GitHub: Developer-focused authentication
Discord: Community platform integration
Twitter/X: Social media authentication

🔑 Web3 Wallet Integration

For blockchain features including NFT marketplace and RING token operations.

MetaMask Setup

Install MetaMask browser extension:

Visit: https://metamask.io/download/

Or install via package manager:

macOS/Linux:

Download from official website

terminal

bash

brew install --cask metamask

Wallet Encryption Key

Generate a secure encryption key for wallet operations:

Generate 256-bit (32-byte) hex key Example output: a1b2c3d4e5f678901234567890abcdef1234567890abcdef1234567890abcdef

terminal

bash

openssl rand -hex 32

💰 Payment Integration (WayForPay)

Required for store checkout and premium features.

WayForPay Account Setup

Create Merchant Account
- Visit WayForPay
- Register as a merchant
- Complete KYC verification
Get API Credentials
- Login to merchant dashboard
- Navigate to API settings
- Copy Merchant Account and Secret Key
Configure Payment Methods
- Enable card payments
- Configure Apple Pay / Google Pay
- Set up currency support (UAH, USD, EUR)

🛠️ Development Tools

Essential Tools

Install Git (if not already installed):

Install development dependencies:

Optional: Install VS Code extensions:

TypeScript and JavaScript Language Features
Tailwind CSS IntelliSense
Prettier - Code formatter
ESLint

terminal

bash

git --version

npm install -g typescript @types/node

Recommended IDE Setup

Visual Studio Code with these extensions:

ms-vscode.vscode-typescript-next
bradlc.vscode-tailwindcss
esbenp.prettier-vscode
dbaeumer.vscode-eslint
ms-vscode.vscode-json

Environment File Template

Create .env.local from the provided template:

terminal

bash

# cp .env.local.template .env.local

🌐 Network Requirements

Development

Internet Connection: Required for package installation and OAuth testing
Local Ports: 3000 (Next.js), 5432 (PostgreSQL)
Firewall: Allow outbound HTTPS connections

Production

SSL Certificate: Required for HTTPS (Let's Encrypt recommended)
Domain: Custom domain recommended
CDN: Optional but recommended for static assets
WebSocket Support: Required for real-time features

🔒 Security Considerations

Environment Variables

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

terminal

bash

AUTH_SECRET=your-auth-secret
AUTH_GOOGLE_ID=your-google-client-id
AUTH_GOOGLE_SECRET=your-google-client-secret
WALLET_ENCRYPTION_KEY=your-32-byte-hex-key

File Permissions

Secure environment files Secure private keys

terminal

bash

chmod 600 .env.local
chmod 600 .env.production

chmod 400 path/to/private-key.pem

🧪 Validation Checklist

Run these commands to verify your setup:

System Validation

Check Node.js and npm:

Check system resources:

Check network connectivity:

terminal

bash

node --version        # v18.17.0+
npm --version         # 8.19.0+

df -h                 # Disk space
free -h              # Memory (Linux)
vm_stat              # Memory (macOS)

curl -I https://registry.npmjs.org/

Database Validation

PostgreSQL: Test connection Or with Docker

terminal

bash

psql -h localhost -U ring_user -d ring_platform -c "SELECT version();"

docker exec -it ring-postgres psql -U ring_user -d ring_platform -c "SELECT 1;"

Firebase (if using): Check Firebase CLI:

terminal

bash

firebase --version

firebase login

OAuth Validation

Test Google OAuth credentials format:

Test Apple credentials (if using):

Validate URLs are accessible:

terminal

bash

echo $AUTH_GOOGLE_ID | grep -E "^[0-9]+-[a-zA-Z0-9_]+.apps.googleusercontent.com$"

echo $AUTH_APPLE_ID | grep -E "^com."

curl -s -o /dev/null -w "%{http_code}" https://accounts.google.com

Web3 Validation

Check wallet encryption key format:

Test MetaMask installation (manual):

Open browser and check for MetaMask extension:

terminal

bash

echo $WALLET_ENCRYPTION_KEY | grep -E "^[a-f0-9]{64}$"

🐛 Troubleshooting Common Issues

Node.js Version Issues

If you see "Node.js version not supported":

terminal

bash

nvm install 18
nvm use 18

# Clear npm cache
npm cache clean --force
rm -rf node_modules package-lock.json
npm install

Database Connection Issues

PostgreSQL: Check if PostgreSQL is running:

Reset PostgreSQL password:

terminal

bash

sudo systemctl status postgresql  # Linux
brew services list | grep postgresql  # macOS

sudo -u postgres psql
ALTER USER ring_user PASSWORD 'new_password';

Firebase: Re-authenticate Firebase Check project access

terminal

bash

firebase logout
firebase login

firebase projects:list

OAuth Configuration Issues

terminal

bash

# Google OAuth errors
# 1. Check authorized origins include your domain
# 2. Verify redirect URIs match exactly
# 3. Ensure Google+ API is enabled

# Apple Sign-in errors
# 1. Verify App ID and Service ID match
# 2. Check private key format and permissions
# 3. Validate return URLs in Apple Developer portal

Network and Firewall Issues

Test connectivity to required services Check DNS resolution Test on different network if issues persist

terminal

bash

curl -I https://accounts.google.com
curl -I https://api.github.com
curl -I https://registry.npmjs.org/

nslookup accounts.google.com

📚 Next Steps

Once all prerequisites are met:

Installation Guide - Clone and set up the project
Environment Configuration - Complete your .env.local setup
First Success Validation - Test your installation
Development Workflow - Start contributing

✅ Ready to Proceed

If 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.

Завантаження документації...

Підготовка контенту платформи Ring

Documentation

Getting Started

Architecture

Architecture Overview

Features

Security & Compliance

Token Staking

Performance

API Reference

CLI Tool

Ring CLI

Customization

Customization Overview

Deployment

Development

Examples

Third-party Integrations

Advanced Features

Real-world Use Cases

White Label

Quick Links