Welcome to Elevate CRM Development!

Welcome to the team! This guide will get you from zero to productive in your first week.

Quick Start Checklist

Day 1: Setup (2-3 hours)

Week 1: Learn & Explore

Day 1: Getting Started

Step 1: Access & Accounts (30 minutes)

Linear Workspace Access

Check Email

Check your email for Linear workspace invitation

Accept Invite

Click the invite link in your email

Verify Access

You should see the Engineering team and current sprint

Firebase Console Access

Check Email

Check your email for Firebase invitation

Accept Invite

Click the invite link in your email to access Firebase Console

Verify Projects

You should see 2 projects:

Production (READ ONLY for now)
Development (You’ll work here)

GitHub Access

Accept GitHub Invite

Accept GitHub repository invitation via email

Set up 2FA

Set up 2FA on your GitHub account (required)

Clone Repository

# Use the repo URL from your invitation email
git clone https://github.com/YOUR_ORG/YOUR_REPO.git
cd YOUR_REPO

Step 2: Development Environment Setup (1 hour)

IDE Setup (VS Code / Cursor)

Recommended: Use Cursor (AI-powered IDE) or VS Code with extensions

Required Extensions:

ESLint (code linting)
Prettier (code formatting)
React snippets
Firebase (Firebase tools)
GitLens (Git integration)

Recommended Settings (.vscode/settings.json):

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "eslint.validate": ["javascript", "javascriptreact"],
  "files.exclude": {
    "**/.git": true,
    "**/node_modules": true
  }
}

Required Software

Check Versions

# Check versions (minimum requirements)
node --version    # v18 or higher
npm --version     # v9 or higher
git --version     # v2.30 or higher

Install Dependencies

Install

cd elevate-crm-clean

# Install Node dependencies
npm install

# Install Firebase CLI globally
npm install -g firebase-tools

# Login to Firebase
firebase login

# Select development project
firebase use dev

Environment Configuration

Environment Setup

# Copy environment template
cp env.development.template .env.local

# Your .env.local should have:
REACT_APP_ENV=development
REACT_APP_FIREBASE_PROJECT_ID=elevate-crm-dev
# ... other vars (contact chandlerking@elevateyouenterprise.com for values)

Getting Environment Variables:

See env.development.template in the repo root for all available variables
Contact chandlerking@elevateyouenterprise.com for actual API keys and Firebase config values
For Firebase Secrets Manager setup, see docs/API_KEYS_SETUP.md in the repository

Step 3: Run the Application (30 minutes)

Start Development Server

# Terminal 1: Start React app
npm start

Verify Setup

Open Browser

Navigate to http://localhost:3000

Check Login Page

You should see the login page

Test Login

Try logging in with your test account

Explore Dashboard

Explore the dashboard

Success! If you can see the dashboard, your setup is complete!

Week 1: Learning the Codebase

Architecture Overview

Tech Stack

Frontend

React 18
Redux Toolkit
TanStack Query
Tailwind CSS

Backend

Firebase Auth
Cloud Firestore
Cloud Functions
Cloud Storage

Dev Tools

Linear (Issues & Sprints)
GitHub (Code & PRs)
Sentry (Error Monitoring)

Forms & Validation

React Hook Form
Zod validation

Project Structure

Directory Structure

elevate-crm-clean/
├── src/
│   ├── features/           # Feature-based organization
│   │   ├── deals/         # Deal management
│   │   ├── rep/           # Rep dashboard & profile
│   │   ├── admin/         # Admin features
│   │   ├── uploads/       # Document uploads
│   │   └── trainings/     # Training materials
│   ├── shared/            # Shared components & utilities
│   │   ├── components/    # Reusable UI components
│   │   ├── hooks/         # Custom React hooks
│   │   ├── services/      # API/business logic
│   │   ├── utils/         # Helper functions
│   │   └── schemas/       # Zod validation schemas
│   ├── core/              # Core app infrastructure
│   │   ├── auth/          # Authentication
│   │   ├── layout/        # App layout components
│   │   └── routing/       # Route configuration
│   └── firebase/          # Firebase configuration
├── functions/             # Firebase Cloud Functions
├── docs/                  # Documentation
└── tests/                # Test files

Key Concepts

1. Role-Based Access Control

Admin

Full access to everything

Manager

Team management + deal oversight

Rep

Own deals + team data

2. Data Flow

User action → Component
↓
Component dispatches Redux action OR React Query mutation
↓
Service layer handles Firebase calls
↓
Update UI based on response

3. Commission Calculations

Commission Formula

Base Commission = Deal Amount × Rep Rate
Team Split = Base × 50% (if applicable)
Manager Override = Custom adjustments
Final Payout = Base + Bonuses - Deductions

Coding Standards

Using Cursor AI? Check out our comprehensive Cursor AI & Clean Code Guide for best practices on using AI coding assistants while maintaining code quality.

File Naming

Components: PascalCase.jsx (e.g., DealCard.jsx)
Utilities: camelCase.js (e.g., formatCurrency.js)
Constants: UPPER_SNAKE_CASE.js (e.g., API_ENDPOINTS.js)
Hooks: use*.js (e.g., useDeals.js)

Component Structure

Component Template

// 1. Imports
import React, { useState } from 'react';
import { useSelector } from 'react-redux';

// 2. Component
export default function DealCard({ deal, onUpdate }) {
  // Hooks
  const user = useSelector(state => state.auth.currentUser);
  const [loading, setLoading] = useState(false);
  
  // Event handlers
  const handleUpdate = async () => {
    setLoading(true);
    try {
      await onUpdate(deal.id);
    } catch (error) {
      console.error('Update failed:', error);
    } finally {
      setLoading(false);
    }
  };
  
  // Render
  return (
    <div className="deal-card">
      {/* JSX */}
    </div>
  );
}

Best Practices

✅ DO These Things

Use React Hook Form for forms
Validate with Zod schemas
Handle loading states
Show user feedback (toasts/alerts)
Use explicit undefined checks: value !== undefined ? value : default
Add error boundaries
Write tests for business logic

❌ DON'T Do These Things

Use var (use const/let)
Mutate state directly
Use .toLower() in Firebase rules (use .lower())
Access production data from dev
Push directly to main branch
Ship with console.log statements
Use falsy checks for numbers: value || default (use explicit checks)

Tutorial Tasks

Task 1: Fix a Simple Bug (1-2 hours)

Goal: Get familiar with the codebase and PR process

Find Issue in Linear

Find an open issue labeled good-first-issue in Linear

Assign to Yourself

Click “Assign to me” and move to “In Progress”

Create Branch

git checkout -b fix/ELE-123-bug-description

(Use Linear issue ID in branch name)

Fix Bug

Fix the bug and test locally

Commit with Linear ID

git commit -m "Fix: [description] (ELE-123)"

Push & Create PR

Push and create PR. Linear will auto-link the PR!

Update Linear

Move Linear issue to “In Review”

Task 2: Add a Feature Enhancement (2-3 hours)

Goal: Learn the feature development workflow Example Task: Add a “Copy to Clipboard” button for deal IDs

Create Feature Branch

Create a new branch for your feature

Add Button Component

Add the button component to the deal card

Implement Functionality

Implement copy to clipboard functionality

Add User Feedback

Add toast notification on success

Test Thoroughly

Test in different browsers and scenarios

Submit PR

Submit PR with screenshots

Task 3: Write Tests (2-3 hours)

Goal: Learn the testing approach

Pick a Function

Pick a utility function (e.g., formatCurrency)

Write Test Cases

Write tests for:

Happy path
Edge cases (0, negative, very large numbers)
Invalid input

Run Tests

npm test

Aim for 100% Coverage

Ensure all code paths are tested

Development Workflow

Daily Workflow

Daily Git Workflow

# 1. Start your day - get latest code
git checkout main
git pull origin main

# 2. Create feature branch
git checkout -b feature/my-awesome-feature

# 3. Make changes and test
npm start  # develop
npm test   # test changes

# 4. Commit frequently
git add .
git commit -m "feat: add awesome feature"

# 5. Push and create PR
git push origin feature/my-awesome-feature
# Then create PR on GitHub

# 6. After PR is merged
git checkout main
git pull origin main
git branch -d feature/my-awesome-feature

Branch Naming Convention

feature/ - New features
fix/ - Bug fixes
refactor/ - Code refactoring
docs/ - Documentation
test/ - Test additions

Commit Message Format

type: short description

- Bullet point details
- What changed
- Why it changed

Fixes #123

Types: feat, fix, refactor, docs, test, chore

Pull Request Process

Create PR

Create PR with clear title and description

Fill Template

Fill out PR template (auto-generated)

Request Review

Request review from senior dev

Address Feedback

Address feedback promptly

Merge

Merge after approval (squash and merge)

Tools & Resources

Development Tools

Team Members: You’ll receive access links to all tools on your first day:

Linear - Issue tracking and sprints
Firebase Console - Backend management
GitHub - Code repository
Sentry - Error monitoring

Communication

Email Support

chandlerking@elevateyouenterprise.com

Documentation

API Docs: API Reference
Team Workflow: Workflow Guide
Cursor AI Guide: Cursor & Clean Code Guide
Testing Strategy: See SAFE_TESTING_STRATEGY.md in repo root
Security Guide: See SECURITY_IMPLEMENTATION_COMPLETE.md in repo root
Project Docs: Check /docs folder for feature-specific documentation

Common Tasks

Running Tests

npm test

Debugging

React DevTools

Install Extension

Install React DevTools browser extension

Open DevTools

Open browser DevTools

Use React Tabs

Use “Components” and “Profiler” tabs

Firebase Debugging

firebase emulators:start --only firestore

Common Issues

Permission denied errors

Fix: Make sure you’re using dev project

firebase use dev

Module not found errors

Fix: Delete node_modules and reinstall

rm -rf node_modules && npm install

Build errors after pulling latest

Fix: Clear cache and rebuild

npm run clean && npm install && npm start

Port 3000 already in use

Fix: Kill the process or use a different port

# Find and kill process
lsof -ti:3000 | xargs kill -9

# Or use different port
PORT=3001 npm start

Firebase authentication errors

Fix: Re-login to Firebase

firebase logout
firebase login
firebase use dev

Git push rejected

Fix: Pull latest changes first

git pull origin dev --rebase
git push origin your-branch-name

Getting Help

Before Asking

Check documentation (especially docs/ folder)
Search existing GitHub issues
Google the error message
Try debugging for 15-20 minutes

When Asking

Be specific! Instead of:

“The deal page isn’t working”

Say:

“When I click ‘Save Deal’ on the Edit Deal page, I get a 403 error in the console. I’m logged in as a test rep account. Screenshot attached.”

Who to Ask

Code Questions

Contact chandlerking@elevateyouenterprise.com

Bug Reports

Create Linear issue with bug label

Feature Requests

Create Linear issue with feature label

Urgent Issues

Email + Linear issue with urgent label

Your First Week Schedule

Monday

✅ Complete setup
✅ Run app locally
✅ Explore codebase

Tuesday-Wednesday

✅ Read architecture docs
✅ Complete Tutorial Task 1
✅ Pair program with senior dev

Thursday-Friday

✅ Start first sprint task
✅ Submit first PR
✅ Team code review session

Success Metrics

Week 1 Goals

Local development environment working
First PR merged
Understand basic architecture
Know where to find help

Month 1 Goals

Completed 5+ PRs
Can work independently on small tasks
Understand commission calculations
Contributing to code reviews

Month 3 Goals

Leading feature development
Mentoring newer devs
Contributing to architecture decisions
Shipping high-quality code consistently

Welcome Aboard! 🎉

You’re joining a growing team building a product that helps solar reps succeed. Your contributions matter! Questions? Ask early and often. We’re here to help!

Need Help?

Contact chandlerking@elevateyouenterprise.com

Quick Reference

Essential Commands

npm start
# Opens http://localhost:3000

Common File Locations

What	Where
Components	`src/features/[feature]/components/`
Services	`src/shared/services/` or `src/features/[feature]/services/`
Hooks	`src/features/[feature]/hooks/` or `src/shared/hooks/`
Firebase Config	`src/firebase/firebaseConfig.js`
Firestore Rules	`firestore.rules`
Firestore Indexes	`firestore.indexes.json`
Environment Variables	`.env.local`
Documentation	`docs/` folder

Keyboard Shortcuts

VS Code / Cursor:

Cmd/Ctrl + P - Quick file open
Cmd/Ctrl + Shift + P - Command palette
Cmd/Ctrl + B - Toggle sidebar
Cmd/Ctrl + \ - Split editor
Cmd/Ctrl + Shift + F - Search in files
F12 - Go to definition
Shift + F12 - Find all references

Browser DevTools:

Cmd/Ctrl + Shift + I - Open DevTools
Cmd/Ctrl + R - Hard refresh
Cmd/Ctrl + Shift + R - Clear cache and refresh

Useful Links

Firebase Console

Backend management

Linear Workspace

Issue tracking (check email for invite)

GitHub Repository

Code repository

Sentry

Error monitoring

Last Updated: November 12, 2025
Maintained By: Development Team
Need Updates? Submit a PR to this doc!

Documentation Index

​Welcome to Elevate CRM Development!

​Quick Start Checklist

​Day 1: Getting Started

​Step 1: Access & Accounts (30 minutes)

​Linear Workspace Access

​Firebase Console Access

​GitHub Access

​Step 2: Development Environment Setup (1 hour)

​IDE Setup (VS Code / Cursor)

​Required Software

​Install Dependencies

​Environment Configuration

​Step 3: Run the Application (30 minutes)

​Start Development Server

​Verify Setup

​Week 1: Learning the Codebase

​Architecture Overview

​Tech Stack

Frontend

Backend

Dev Tools

Forms & Validation

​Project Structure

​Key Concepts

Admin

Manager

Rep

​Coding Standards

​File Naming

​Component Structure

​Best Practices

​Tutorial Tasks

​Task 1: Fix a Simple Bug (1-2 hours)

​Task 2: Add a Feature Enhancement (2-3 hours)

​Task 3: Write Tests (2-3 hours)

​Development Workflow

​Daily Workflow

​Branch Naming Convention

​Commit Message Format

​Pull Request Process

​Tools & Resources

​Development Tools

​Communication

Email Support

​Documentation

​Common Tasks

​Running Tests

​Debugging

​React DevTools

​Firebase Debugging

​Common Issues

​Getting Help

​Before Asking

​When Asking

​Who to Ask

Code Questions

Bug Reports

Feature Requests

Urgent Issues

​Your First Week Schedule

​Success Metrics

​Week 1 Goals

​Month 1 Goals

​Month 3 Goals

​Welcome Aboard! 🎉

Need Help?

​Quick Reference

​Essential Commands

​Common File Locations

​Keyboard Shortcuts

​Useful Links

Firebase Console

Linear Workspace

GitHub Repository

Sentry

Welcome to Elevate CRM Development!

Quick Start Checklist

Day 1: Getting Started

Step 1: Access & Accounts (30 minutes)

Linear Workspace Access

Firebase Console Access

GitHub Access

Step 2: Development Environment Setup (1 hour)

IDE Setup (VS Code / Cursor)

Required Software

Install Dependencies

Environment Configuration

Step 3: Run the Application (30 minutes)

Start Development Server

Verify Setup

Week 1: Learning the Codebase

Architecture Overview

Tech Stack

Project Structure

Key Concepts

Coding Standards

File Naming

Component Structure

Best Practices

Tutorial Tasks

Task 1: Fix a Simple Bug (1-2 hours)

Task 2: Add a Feature Enhancement (2-3 hours)

Task 3: Write Tests (2-3 hours)

Development Workflow

Daily Workflow

Branch Naming Convention

Commit Message Format

Pull Request Process

Tools & Resources

Development Tools

Communication

Documentation

Common Tasks

Running Tests

Debugging

React DevTools

Firebase Debugging

Common Issues

Getting Help

Before Asking

When Asking

Who to Ask

Your First Week Schedule

Success Metrics

Week 1 Goals

Month 1 Goals

Month 3 Goals

Welcome Aboard! 🎉

Quick Reference

Essential Commands

Common File Locations

Keyboard Shortcuts

Useful Links