Installation
This guide walks you through a complete setup of Ring Platform for local development.
Prerequisites
- Node.js 22.9+ and npm 10.8+
- Firebase project (Firestore + Auth)
- Google Cloud OAuth credentials
1) Initialize the project
terminal
bash
git clone https://github.com/connectplatform/ring.git
cd ring
npm install2) Configure environment
cp env.local.template .env.local
terminal
bash
npm run setup:envEssential keys (see ring/env.local.template):
AUTH_FIREBASE_PROJECT_ID=
dotenv
AUTH_FIREBASE_CLIENT_EMAIL=
AUTH_FIREBASE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
"
NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_APP_ID=
AUTH_GOOGLE_ID=
AUTH_GOOGLE_SECRET=
WALLET_ENCRYPTION_KEY=3) Firebase setup
- Enable Authentication (Google provider)
- Create Firestore DB (test mode for local)
- Optional: configure Storage and Cloud Messaging (VAPID key)
4) Run
terminal
bash
npm run devKeep private keys quoted and with literal newlines.