Project Types

Projex supports multiple project types, each suited to different scenarios.

GitHub (github)

Fetches repo data from the GitHub API automatically.

{
  id: 'my-lib',
  type: 'github',
  repo: 'username/repo-name',
  status: 'active',
}

Auto-populated fields: name, description, stars, forks, language, links

NPM (npm)

Fetches package data from npm registry.

{
  id: 'my-package',
  type: 'npm',
  package: 'my-package-name',
  status: 'active',
}

Auto-populated fields: name, downloads, version, npm link

Note: By default, npm projects do not have automatic timestamps for sorting. Enable them with fetchNpmTimestamps: true in defineProjects:

defineProjects([
  { id: 'my-package', type: 'npm', package: 'my-package', status: 'active' },
], {
  fetchNpmTimestamps: true,  // Extracts `createdAt` and `updatedAt` from npm registry
})

When enabled, timestamps come from npm's time.created and time.modified fields.

Product Hunt (product-hunt)

Fetches post data from Product Hunt.

{
  id: 'my-launch',
  type: 'product-hunt',
  slug: 'my-product-slug',
  status: 'shipped',
}

Auto-populated fields: name, tagline, description, upvotes, comments, launch date

Hybrid (hybrid)

Combines GitHub and NPM data for packages with both repo and registry presence.

{
  id: 'full-stack-lib',
  type: 'hybrid',
  repo: 'username/lib',
  package: 'my-lib',
  status: 'active',
}

Auto-populated fields: Combined from both sources

Note: When fetchNpmTimestamps: true is enabled, updatedAt is set to the most recent of GitHub's updated_at and npm's time.modified. This accurately reflects the last activity whether it was a code change or a new package version.

Manual (manual)

Full control with no automatic data fetching. Use for client work, private projects, or anything custom.

{
  id: 'client-project',
  type: 'manual',
  status: 'shipped',
  name: 'Client E-commerce',
  tagline: 'Custom storefront build',
  description: 'Full rebuild of a Shopify storefront...',
  links: { live: 'https://example.com' },
  stack: ['Next.js', 'Shopify'],
}

Note: Manual projects have no automatic data fetching, including timestamps. If you want to sort manual projects by date, you must manually specify createdAt and updatedAt:

{
  id: 'client-project',
  type: 'manual',
  status: 'shipped',
  name: 'Client E-commerce',
  tagline: 'Custom storefront build',
  description: 'Full rebuild of a Shopify storefront...',
  links: { live: 'https://example.com' },
  stack: ['Next.js', 'Shopify'],
  createdAt: '2024-01-01',
  updatedAt: '2024-06-01',
}

YouTube (youtube)

Fetches channel data from YouTube API.

{
  id: 'my-channel',
  type: 'youtube',
  channelId: 'UC_x5XG1OV2P6uZZ5FSM9Ttw',
  status: 'active',
}

Auto-populated fields: subscribers, views, latest video title, latest video URL, latest video published date

Environment variable: YOUTUBE_TOKEN (required) - Create an API key at Google Cloud Console

Gumroad (gumroad)

Fetches product data from Gumroad API.

{
  id: 'my-product',
  type: 'gumroad',
  productId: 'prod_test123',
  status: 'shipped',
}

Auto-populated fields: formatted revenue, sales count, subscriber count

Environment variable: GUMROAD_TOKEN (required) - Create an access token at Gumroad Settings

Note: Gumroad API does not provide timestamp fields. If you want to sort Gumroad projects by date, you must manually specify createdAt and updatedAt:

{
  id: 'my-product',
  type: 'gumroad',
  productId: 'prod_test123',
  status: 'shipped',
  createdAt: '2024-01-01',
  updatedAt: '2024-06-01',
}

Lemon Squeezy (lemonsqueezy)

Fetches store data from Lemon Squeezy API.

{
  id: 'my-store',
  type: 'lemonsqueezy',
  storeId: '12345',
  status: 'active',
}

Auto-populated fields: formatted MRR, order count, customer count

Environment variable: LS_TOKEN (required) - Get from Lemon Squeezy Settings

Note: Lemon Squeezy API does not provide timestamp fields. If you want to sort Lemon Squeezy projects by date, you must manually specify createdAt and updatedAt:

{
  id: 'my-store',
  type: 'lemonsqueezy',
  storeId: '12345',
  status: 'active',
  createdAt: '2024-01-01',
  updatedAt: '2024-06-01',
}

Dev.to (devto)

Fetches user data from Dev.to API.

{
  id: 'my-devto',
  type: 'devto',
  username: 'your-username',
  status: 'active',
}

Auto-populated fields: article count, total views, total reactions

Environment variable: DEV_TO_API_KEY (optional) — Without it, page_views_count is unavailable and totalViews will be 0. Create one at https://dev.to/settings/extensions

Project Status

Each project has a status that indicates its current state:

Status	Use For
active	Maintained projects
shipped	Completed products
in-progress	Currently building
coming-soon	Not yet released
archived	No longer maintained
for-sale	Available for purchase

Extended Fields

Beyond the basic fields, you can add rich metadata to your projects:

{
  id: 'my-project',
  type: 'github',
  repo: 'username/repo',
  status: 'active',

  featured: true,
  
  background: 'A deeper dive into the project context',
  
  why: 'The motivation behind building this project',
  
  stack: ['TypeScript', 'React', 'Next.js'],
  
  struggles: [
    { type: 'challenge', text: 'First challenge we faced' },
    { type: 'learning', text: 'Technical decision explanation' },
  ],
  
  timeline: [
    { date: '2025-01', note: 'Initial concept' },
    { date: '2025-02', note: 'First release' },
    { date: '2025-03', note: 'Major feature launch' },
  ],
}

Field descriptions:

• featured: boolean — Promote this project in featured sections
• background: string — Longer description for project detail pages
• why: string — Motivation or problem this project solves
• stack: string[] — Technologies used in the project
• struggles: Array<{type: 'challenge' | 'learning', text: string}> — Challenges faced and lessons learned
• timeline: Array<{date: string, note: string}> — Project milestones and history