Getting Started

Status: ✅ Production Ready
Base URL: https://id.optare.one

🚀 Quick Start (5 Minutes)

1. Get API Credentials

Visit: https://id.optare.one/admin
Settings → API Keys → Create New Key
Copy: API Key & Secret

2. Update Environment

# Add to .env.local
OPTARE_API_KEY=sk_live_xxxxx
OPTARE_API_SECRET=sk_secret_xxxxx

3. Install & Run

pnpm install
pnpm optare:setup

Done! ✅

📚 Documentation Structure

Docs/
├── 00-GETTING-STARTED/    ← You are here
├── 01-CLI-AUTOMATION/     ← CLI tool guide
├── 02-OAUTH-INTEGRATION/  ← OAuth 2.0 guide
├── 03-API-REFERENCE/      ← API documentation
├── 04-ADMIN-GUIDE/        ← Admin portal guide
├── 05-CLIENT-GUIDE/       ← Client portal guide
├── 06-SDK-REFERENCE/      ← SDK documentation
├── 07-ARCHITECTURE/       ← Architecture guide
├── 08-SECURITY/           ← Security guide
├── 09-DEPLOYMENT/         ← Deployment guide
└── 10-FAQ/                ← FAQ section

🎯 Choose Your Path

👨‍💻 I'm a Developer

Read: QUICK-START.md
Read: ../01-CLI-AUTOMATION/README.md
Read: ../02-OAUTH-INTEGRATION/README.md
Reference: ../03-API-REFERENCE/README.md

👨‍💼 I'm an Admin

👥 I'm an End User

🏗️ I'm an Architect

✨ Key Features

✅ OAuth 2.0 integration
✅ RESTful API
✅ Admin portal
✅ Client portal
✅ CLI automation
✅ TypeScript SDK
✅ Production ready

📞 Next Steps

Choose your path above
Read the relevant guide
Follow the step-by-step instructions
Reference the API docs as needed

Next: QUICK-START.md or NAVIGATION.md

Database Setup Getting Started Overview