Case Study Generator v2.0 by Kairo Collective

A Node.js CLI tool from Kairo Collective to help devs, freelancers, and project teams generate professional, comprehensive case studies—ready to showcase on GitHub, LinkedIn, or share with clients.

---

Features

• Detailed, assistant-style prompts for every section
• Optional sections—skip any topic you don’t need (it won’t show in the output)
• Easy tagging for personal projects and solo case studies
• Preview-before-save for every case study
• Clean markdown output, perfect for portfolios or PDF export
• Auto-naming for each generated case study
• Community-friendly—open to feedback, ideas, and contributions!

---

Installation

Make sure you have Node.js installed.

Install Dependencies

npm install inquirer chalk

---

Usage

From your terminal, run:

node caseStudyGenerator.js

• Answer the guided questions
• Preview your case study markdown
• Save or skip any section
• Generates a .md file named: case-study-[project-name].md in your working directory

---

Example Output

Case Study: Project Name Overview Project Name: ...

Date Completed: ...

Client/Organization: ...

Your Role: ...

Project Type: ...

Team Members: ...

Project Goals ...

Challenge / Problem Statement ...

Solution / Approach ...

Technologies Used ...

Implementation ...

Deployment & DevOps ...

Results & Impact ...

Visual Showcase ...

Key Learnings & Reflections ...

Future Enhancements ...

Testimonials ...

Links & Media ...

Generated with Professional Case Study Generator v2.0 by Kairo Collective

---

PDF Export

• VS Code Extension: Install "Markdown PDF" from the VS Code Marketplace.
  1. Open your .md file in VS Code
  2. Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
  3. Select "Markdown PDF: Export (pdf)"
  4. Done!

---

Example Case Study Output

Want to see the output before you start? View or download this example PDF.

---

Contributing

Suggestions and PRs are always welcome. If you use this for your own portfolio, please let me know!

---

License

MIT

---

Made with care by Kairo Collective | Carmen Wheeler
Connect with me on LinkedIn