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

2) Configure environment

cp env.local.template .env.local

terminal

bash

Essential keys (see ring/env.local.template):

AUTH_FIREBASE_PROJECT_ID=

dotenv

3) Firebase setup

Enable Authentication (Google provider)
Create Firestore DB (test mode for local)
Optional: configure Storage and Cloud Messaging (VAPID key)

4) Run

✅ http://localhost:3000

terminal

bash

Keep private keys quoted and with literal newlines.

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

2) Configure environment

cp env.local.template .env.local

terminal

bash

Essential keys (see ring/env.local.template):

AUTH_FIREBASE_PROJECT_ID=

dotenv

3) Firebase setup

Enable Authentication (Google provider)
Create Firestore DB (test mode for local)
Optional: configure Storage and Cloud Messaging (VAPID key)

4) Run

✅ http://localhost:3000

terminal

bash

Keep private keys quoted and with literal newlines.

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

2) Configure environment

cp env.local.template .env.local

terminal

bash

Essential keys (see ring/env.local.template):

AUTH_FIREBASE_PROJECT_ID=

dotenv

3) Firebase setup

Enable Authentication (Google provider)
Create Firestore DB (test mode for local)
Optional: configure Storage and Cloud Messaging (VAPID key)

4) Run

✅ http://localhost:3000

terminal

bash

Keep private keys quoted and with literal newlines.