Skip to content

SETUP.md

Latest commit

 

History

History
97 lines (76 loc) · 2.24 KB

SETUP.md

File metadata and controls

97 lines (76 loc) · 2.24 KB

RankKit - Setup Instructions

Project initialized! Here's what's been built:

✅ Completed

  • Project structure created
  • Firebase integration ready
  • OpenAI API service configured
  • Authentication flow (Email + Google)
  • Dashboard UI
  • ResumeRank module (resume optimizer)
  • PostRank module (social post optimizer)
  • Basic styling

🔧 What You Need to Do

1. Create Firebase Project

  1. Go to https://console.firebase.google.com
  2. Create new project "RankKit"
  3. Enable Authentication:
    • Email/Password
    • Google Sign-In
  4. Create Firestore database (start in production mode)
  5. Get your Firebase config from Project Settings

2. Get OpenAI API Key

  1. Go to https://platform.openai.com/api-keys
  2. Create new API key
  3. Copy it for the functions secret step

3. Add Your Credentials

Copy .env.example to .env and set your REACT_APP_FIREBASE_* values.

4. Set OpenAI Secret (server-side)

firebase functions:secrets:set OPENAI_API_KEY

5. Deploy Functions + Hosting

firebase deploy --only functions,hosting

6. Run the App

cd /workspaces/rankkit
npm start

The app will open at http://localhost:3000

📋 What's Built

Authentication

  • /login - Email + Google sign-in
  • /signup - Create account
  • Protected routes (redirects to login if not authenticated)

Dashboard

  • /dashboard - Main hub showing both tools
  • Usage tracking (free tier: 3 optimizations)
  • Upgrade prompts

ResumeRank

  • /resume - Resume optimizer
  • Paste job posting + resume
  • Get ATS match score + optimized version
  • See key improvements

PostRank

  • /post - Social media post optimizer
  • Select platform (IG/TikTok/YouTube/Twitter)
  • Paste caption
  • Get engagement score + optimized version + hashtags

🚀 Next Steps (After Testing)

  1. Add Stripe for payments
  2. Save optimizations to Firestore
  3. Build landing page
  4. Deploy to Firebase Hosting

💾 Current State

  • Code is ready to run
  • Need Firebase + OpenAI credentials
  • All UI components built
  • Basic functionality working

When you're back, just:

  1. Set up Firebase project (10 min)
  2. Get OpenAI API key (2 min)
  3. Set OPENAI_API_KEY functions secret (1 min)
  4. Run npm start

Then we can test it and iterate. 💙