Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DevBrief

DevBrief is a small developer-focused LinkedIn toolbox that turns rough project notes into a polished career brief.

It is built for software engineers who want to show their work clearly without turning every post into generic marketing copy. Paste rough notes about a project, choose the intended audience and tone, and DevBrief generates:

  • a LinkedIn project post
  • a carousel outline
  • a featured project blurb
  • a sharper profile headline
  • a portfolio-readiness score

Why This Exists

Developers often have strong technical work hidden behind weak presentation:

  • scattered commit history
  • unfinished README notes
  • too much implementation detail
  • no clear value proposition
  • no reusable content for LinkedIn or a portfolio

DevBrief helps structure raw project context into public-facing material while keeping the technical substance visible.

Demo Workflow

  1. Add a project name and rough notes.
  2. Select the target audience and communication tone.
  3. Review the generated career brief.
  4. Copy the section you need for LinkedIn, GitHub, or your portfolio.

The app runs fully in the browser and stores draft input locally on the device.

Tech Stack

  • HTML
  • CSS
  • Vanilla JavaScript modules
  • Node.js test runner
  • No runtime dependencies

Getting Started

npm run dev

Then open:

http://localhost:4173

You can also open index.html directly in a browser.

No external dependencies are required for the first version.

Quality Checks

npm run verify

This runs syntax checks and unit tests for the content generation logic.

GitHub Pages

The repository includes a GitHub Pages workflow. After pushing the project to GitHub, enable GitHub Pages with GitHub Actions as the source in the repository settings.

The static app is deployed from the repository root and does not require a build step.

Project Structure

.
├── .github/
│   └── workflows/
│       ├── ci.yml
│       └── pages.yml
├── index.html
├── package.json
├── scripts/
│   └── serve.mjs
├── src/
│   ├── app.js
│   ├── contentEngine.js
│   ├── sampleData.js
│   └── styles.css
└── tests/
    └── contentEngine.test.js

Portfolio Angle

DevBrief is intentionally small, but it demonstrates product thinking:

  • transforming unstructured input into structured output
  • separating pure business logic from UI code
  • designing for a realistic creator workflow
  • keeping the first version dependency-free and easy to host
  • adding tests around the parts most likely to regress

Roadmap

  • GitHub repository import
  • README-to-LinkedIn analysis
  • carousel PDF export
  • AI-assisted copy variants
  • GitHub Pages deployment workflow
  • project history saved in local workspaces

License

MIT

About

A developer-focused LinkedIn toolbox for turning rough project notes into a polished career brief.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages