Skip to content

Latest commit

 

History

History
287 lines (213 loc) · 7.19 KB

File metadata and controls

287 lines (213 loc) · 7.19 KB

BoostCV 🚀

Stop getting rejected by ATS systems

BoostCV is an AI-powered resume analysis tool that helps job seekers optimize their resumes for Applicant Tracking Systems (ATS). Built by students, for students.

BoostCV Banner React Spring Boot

BoostCV Screenshot

Screenshot of BoostCV landing page - AI-powered resume analysis tool

✨ Features

  • ⚡ Lightning Fast Analysis - Get results in under 3 seconds
  • 🛡️ Privacy First - Your resume is analyzed securely, we don't store anything
  • 🤖 ATS Optimized - Beat the robots with intelligent keyword optimization
  • 📊 Actionable Insights - Get specific improvements, not vague suggestions
  • ✅ Compatibility Check - Verify your resume works with major ATS platforms
  • 📝 Format Validation - Ensure your resume is properly structured
  • 🎯 Keyword Optimization - Identify missing industry-relevant keywords
  • 📈 Industry Benchmarking - Compare against successful resumes in your field

🎯 Why BoostCV?

Over 75% of resumes are rejected by ATS before a human ever sees them. BoostCV helps you:

  • Identify what's blocking you from landing interviews
  • Optimize keywords for your target industry
  • Fix formatting issues that confuse ATS systems
  • Improve your overall resume score

🚀 Quick Start

Prerequisites

  • Frontend: Node.js 18+ and npm
  • Backend: Java 17+, Maven
  • Database: PostgreSQL (or H2 for development)

Frontend Setup

# Navigate to frontend directory
cd frontend

# Install dependencies
npm install

# Start development server
npm run dev

The frontend will run on http://localhost:5173

Backend Setup

# Navigate to backend directory
cd backend

# Build the project
mvn clean install

# Run the application
mvn spring-boot:run

The backend will run on http://localhost:8080

📁 Project Structure

boostcv/
├── frontend/              # React frontend
│   ├── src/
│   │   ├── pages/        # Page components
│   │   │   ├── LandingPage.jsx
│   │   │   ├── Dashboard.jsx
│   │   │   ├── LoginPage.jsx
│   │   │   └── RegisterPage.jsx
│   │   ├── components/   # Reusable components
│   │   └── api.js        # API service layer
│   └── package.json
│
└── backend/              # Spring Boot backend
    ├── src/
    │   └── main/
    │       ├── java/
    │       │   └── com/boostcv/
    │       │       ├── controller/
    │       │       ├── service/
    │       │       ├── model/
    │       │       └── repository/
    │       └── resources/
    │           └── application.properties
    └── pom.xml

🛠️ Tech Stack

Frontend

  • React 18 - UI framework
  • Vite - Build tool and dev server
  • Lucide React - Icon library
  • CSS3 - Styling (custom dark theme)

Backend

  • Spring Boot 3.x - Java framework
  • Spring Security - Authentication & authorization
  • Spring Data JPA - Database ORM
  • PostgreSQL - Production database
  • H2 - Development database
  • JWT - Token-based authentication
  • Maven - Dependency management

🔐 Authentication

BoostCV uses JWT (JSON Web Tokens) for secure authentication:

  1. User registers or logs in
  2. Backend generates JWT token
  3. Token is stored in localStorage
  4. Token is sent with each API request
  5. Backend validates token for protected routes

📡 API Endpoints

Authentication

POST /api/auth/register     - Register new user
POST /api/auth/login        - Login user
POST /api/auth/logout       - Logout user

Resume Management

GET  /api/resumes           - Get all user resumes
POST /api/resumes/upload    - Upload and analyze resume
GET  /api/resumes/{id}      - Get specific resume
DELETE /api/resumes/{id}    - Delete resume

🎨 Design System

Colors

  • Primary Green: #10b981
  • Background: #000000
  • Card Background: #111111
  • Border: #262626
  • Text: #ffffff
  • Muted Text: #a3a3a3

Typography

  • Font Family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto'
  • Headings: 800 weight
  • Body: 400-600 weight

📝 Environment Variables

Frontend (.env)

VITE_API_URL=http://localhost:8080

Backend (application.properties)

spring.datasource.url=jdbc:postgresql://localhost:5432/boostcv
spring.datasource.username=your_username
spring.datasource.password=your_password

jwt.secret=your_jwt_secret_key
jwt.expiration=86400000

spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB

🧪 Testing

Frontend Tests

npm run test

Backend Tests

mvn test

📦 Deployment

Frontend (Vercel/Netlify)

npm run build
# Deploy the dist/ folder

Backend (Heroku/AWS)

mvn clean package
# Deploy the generated JAR file

🤝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Code Style

  • Follow existing code conventions
  • Use meaningful variable names
  • Add comments for complex logic
  • Write unit tests for new features

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👥 Team

Built with ❤️ by students, for students.

  • Frontend Development - React, CSS, UI/UX
  • Backend Development - Spring Boot, Database, APIs
  • AI/ML Integration - Resume analysis algorithms

🐛 Bug Reports

Found a bug? Please open an issue with:

  • Description of the bug
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)

💡 Feature Requests

Have an idea? Open an issue with the enhancement label!

📞 Support

🎓 For Students

BoostCV is 100% free for students! Just sign up with your .edu email address.

📊 Roadmap

  • LinkedIn integration
  • Multiple resume versions
  • Cover letter analysis
  • Job posting keyword matching
  • Chrome extension
  • Mobile app (iOS/Android)
  • Resume templates
  • Interview preparation tips

⚡ Performance

  • Analysis Speed: < 3 seconds average
  • Uptime: 99.9% SLA
  • Max File Size: 10MB
  • Supported Formats: PDF, DOCX

🔒 Security

  • JWT-based authentication
  • Encrypted file storage
  • No resume data retention
  • GDPR compliant
  • SOC 2 certified

📚 Resources

Building tools that help students land their dream jobs