Skip to content

Documentation improvements + code cleanup #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jared-Krajewski merged 3 commits into from
Sep 10, 2025
Merged

Documentation improvements + code cleanup #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e68439f
updated main readme and consolidated env readme into it, linting to R…
Jared-Krajewski Sep 10, 2025
fa16088
linting backend
Jared-Krajewski Sep 10, 2025
437c099
reverted llama model back to 3b
Jared-Krajewski Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ help: ## Show this help message
@echo ""
@echo "$(YELLOW)🚀 Quick Start:$(NC)"
@echo " $(GREEN)make dev-setup$(NC) Set up development environment"
@echo " $(GREEN)make dev-groq$(NC) Fast development with Groq API (recommended)"
@echo " $(GREEN)make dev-groq$(NC) Development with Groq API (recommended)"
@echo " $(GREEN)make start$(NC) Full setup with local AI models"
@echo ""
@echo "$(YELLOW)📋 Development Commands:$(NC)"
Expand Down Expand Up @@ -167,7 +167,7 @@ status: ## Show status of all containers

pull-model: ## Download/update the AI model (llama3.2)
@echo "$(BLUE)🧠 Downloading llama3.2 model...$(NC)"
@echo "$(YELLOW)This may take a while depending on your internet connection$(NC)"
@echo "$(YELLOW)🪑This may take a while depending on your internet connection$(NC)"
docker exec $(PROJECT_NAME)-ollama ollama pull llama3.2
@echo "$(GREEN)✅ Model downloaded successfully$(NC)"

Expand Down Expand Up @@ -221,8 +221,7 @@ dev-groq: ## Start lightweight development setup (frontend + backend only, optim
@echo "$(BLUE)⚡ Starting Groq-optimized development setup...$(NC)"
docker compose -f $(DEV_GROQ_COMPOSE) up -d --build --remove-orphans
@echo "$(GREEN)✅ Lightweight development services started with hot reload$(NC)"
@echo "$(YELLOW)Use Groq API in the frontend for fast resume optimization$(NC)"
@echo "$(YELLOW)💡 Add your Groq API key in the frontend for ultra-fast optimization$(NC)"
@echo "$(YELLOW)💡 Add your Groq API key in the frontend for web based optimization$(NC)"
@echo ""
@echo "$(BLUE)🌐 Service URLs:$(NC)"
@echo "$(GREEN)Frontend: $(NC)http://localhost:3000"
Expand Down Expand Up @@ -317,7 +316,7 @@ dev-setup: ## Set up local development tools (linting, formatting, pre-commit ho
@echo "$(GREEN)✅ Development tools setup complete!$(NC)"
@echo ""
@echo "$(BLUE)🎯 Next steps:$(NC)"
@echo " $(GREEN)make dev-groq$(NC) Start development (Groq API - fast)"
@echo " $(GREEN)make dev-groq$(NC) Start development (Groq API)"
@echo " $(GREEN)make dev$(NC) Start development (local AI)"
@echo " $(GREEN)make lint$(NC) Check code quality"
@echo " $(GREEN)make format$(NC) Fix formatting issues"
Loading