{"id":46618868,"url":"https://github.com/fydemy/cms","last_synced_at":"2026-03-07T21:02:02.932Z","repository":{"id":327871980,"uuid":"1111088276","full_name":"fydemy/cms","owner":"fydemy","description":"A lightweight CMS for Next.js","archived":false,"fork":false,"pushed_at":"2026-01-18T07:21:02.000Z","size":380,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-18T16:52:53.338Z","etag":null,"topics":["cms","nextjs"],"latest_commit_sha":null,"homepage":"https://fydemy.com","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fydemy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-06T08:43:52.000Z","updated_at":"2026-01-18T07:21:06.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/fydemy/cms","commit_stats":null,"previous_names":["fydemy/cms"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/fydemy/cms","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fydemy%2Fcms","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fydemy%2Fcms/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fydemy%2Fcms/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fydemy%2Fcms/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fydemy","download_url":"https://codeload.github.com/fydemy/cms/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fydemy%2Fcms/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30231489,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T19:01:10.287Z","status":"ssl_error","status_checked_at":"2026-03-07T18:59:58.103Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cms","nextjs"],"created_at":"2026-03-07T21:02:01.999Z","updated_at":"2026-03-07T21:02:02.923Z","avatar_url":"https://github.com/fydemy.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @fydemy/cms\n\n[![npm version](https://badge.fury.io/js/@fydemy%2Fcms.svg)](https://www.npmjs.com/package/@fydemy/cms)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)\n[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org/)\n\nA minimal, secure, file-based CMS for Next.js without database requirements. Store content as markdown files with GitHub integration for production deployments.\n\n## Features\n\n- 📝 **File-based Storage** - Markdown files with frontmatter in `/public/content`\n- 🔐 **Secure Authentication** - Timing-safe password comparison, rate limiting, input validation\n- 🚀 **Vercel Compatible** - Deploy without any database setup\n- 🐙 **GitHub Integration** - Automatic file commits in production\n- 📦 **Zero Config** - Minimal setup required\n- 🎯 **TypeScript First** - Full type safety with comprehensive type definitions\n- ⚡ **Lightweight** - Small bundle size (~30KB), minimal dependencies\n- 🛡️ **Security Hardened** - Built with security best practices\n\n## Installation\n\n```bash\nnpm install @fydemy/cms\n# or\npnpm add @fydemy/cms\n# or\nyarn add @fydemy/cms\n```\n\n## Quick Start\n\n### 1. Initialize the CMS\n\nRun the initialization command in your Next.js App Router project:\n\n```bash\nnpx fydemy-cms init\n```\n\nThis command will automatically:\n\n- Create the content directory\n- Scaffold Admin UI pages (`/app/admin`)\n- Create API routes (`/app/api/cms`)\n- Create a `.env.local.example` file\n- Provide instructions for updating `middleware.ts`\n\n### 2. Configure Environment\n\nCopy `.env.local.example` to `.env.local` and set your credentials:\n\n```bash\ncp .env.local.example .env.local\n```\n\nUpdate variables in `.env.local`:\n\n```env\n# Required for authentication\nCMS_ADMIN_USERNAME=admin\nCMS_ADMIN_PASSWORD=your_secure_password\nCMS_SESSION_SECRET=your-secret-key-must-be-at-least-32-characters-long\n\n# Optional: For production (GitHub integration)\nGITHUB_TOKEN=ghp_your_github_token\nGITHUB_REPO=username/repository\nGITHUB_BRANCH=main\n```\n\n\u003e **Security Note**: Use strong passwords and keep `CMS_SESSION_SECRET` at least 32 characters long.\n\n### 3. Read Content in Your App\n\n```typescript\nimport { getMarkdownContent } from \"@fydemy/cms\";\n\nexport default async function BlogPost({\n  params,\n}: {\n  params: { slug: string };\n}) {\n  const post = await getMarkdownContent(`${params.slug}.md`);\n\n  return (\n    \u003carticle\u003e\n      \u003ch1\u003e{post.data.title}\u003c/h1\u003e\n      \u003cp\u003e{post.data.description}\u003c/p\u003e\n      \u003cdiv\u003e{post.content}\u003c/div\u003e\n    \u003c/article\u003e\n  );\n}\n```\n\n## Security Features\n\n### Built-in Security\n\n- **Timing-Safe Authentication**: Uses `crypto.timingSafeEqual` to prevent timing attacks\n- **Rate Limiting**: 5 login attempts per 15 minutes per IP address\n- **Input Validation**: All inputs validated and sanitized\n- **Path Validation**: Prevents directory traversal attacks\n- **File Size Limits**: Default 10MB maximum file size\n- **Secure Sessions**: httpOnly, sameSite, and secure cookies in production\n- **No Username Enumeration**: Generic error messages\n\n### Security Best Practices\n\n1. **Strong Credentials**: Use strong, unique passwords for `CMS_ADMIN_PASSWORD`\n2. **Secret Management**: Keep `CMS_SESSION_SECRET` at least 32 characters\n3. **GitHub Token Security**: Use minimal permissions (only `repo` scope)\n4. **HTTPS Only**: Always use HTTPS in production\n5. **Regular Updates**: Keep dependencies up to date\n6. **Environment Variables**: Never commit `.env` files\n\nFor more security information, see [SECURITY.md](./SECURITY.md).\n\n## API Reference\n\n### Content Management\n\n```typescript\n// Read markdown file\nconst content = await getMarkdownContent(\"blog/post.md\");\n// Returns: { data: {...}, content: \"...\" }\n\n// Write markdown file\nawait saveMarkdownContent(\n  \"blog/post.md\",\n  { title: \"My Post\", date: \"2024-01-01\" },\n  \"# Hello World\"\n);\n\n// Delete file\nawait deleteMarkdownContent(\"blog/post.md\");\n\n// List files\nconst files = await listMarkdownFiles(\"blog\");\n// Returns: ['blog/post1.md', 'blog/post2.md']\n\n// Check if file exists\nconst exists = await markdownFileExists(\"blog/post.md\");\n```\n\n### Parsing Utilities\n\n```typescript\nimport { parseMarkdown, stringifyMarkdown } from \"@fydemy/cms\";\n\n// Parse markdown string\nconst { data, content } = parseMarkdown(rawMarkdown);\n\n// Convert to markdown\nconst markdown = stringifyMarkdown({ title: \"Post\" }, \"Content here\");\n```\n\n### Authentication\n\n```typescript\nimport { validateCredentials, createSession } from \"@fydemy/cms\";\n\n// Validate credentials\nconst isValid = validateCredentials(\"admin\", \"password\");\n\n// Create session (returns JWT)\nconst token = await createSession(\"admin\");\n```\n\n### Validation Utilities\n\n```typescript\nimport {\n  validateFilePath,\n  validateUsername,\n  validatePassword,\n  sanitizeFrontmatter,\n} from \"@fydemy/cms\";\n\n// Validate file path (prevents directory traversal)\nconst safePath = validateFilePath(\"blog/post.md\");\n\n// Validate username\nvalidateUsername(\"admin\"); // throws if invalid\n\n// Sanitize frontmatter data\nconst safe = sanitizeFrontmatter({ title: \"Test\", script: \"\u003cscript\u003e\" });\n```\n\n## Storage\n\n### Development\n\nFiles are stored locally in `/public/content` directory.\n\n### Production\n\nWhen `NODE_ENV=production` and `GITHUB_TOKEN` is set, all file operations are performed via GitHub API, creating commits directly to your repository.\n\n## Environment Variables\n\n| Variable             | Required   | Description                     |\n| -------------------- | ---------- | ------------------------------- |\n| `CMS_ADMIN_USERNAME` | Yes        | Admin username                  |\n| `CMS_ADMIN_PASSWORD` | Yes        | Admin password                  |\n| `CMS_SESSION_SECRET` | Yes        | JWT secret (min 32 chars)       |\n| `GITHUB_TOKEN`       | Production | GitHub personal access token    |\n| `GITHUB_REPO`        | Production | Repository (format: owner/repo) |\n| `GITHUB_BRANCH`      | Production | Branch name (default: main)     |\n\n## GitHub Setup\n\n1. Create a GitHub Personal Access Token with `repo` permissions\n2. Add the token to your environment variables\n3. Deploy to Vercel and configure the environment variables\n\n## FAQ\n\n### Is this suitable for production?\n\nYes! The package includes security hardening, rate limiting, and has been tested for production use. Make sure to follow security best practices.\n\n### Can I use this with other frameworks?\n\nThis package is designed for Next.js App Router (13+). For other frameworks, you can use the core utilities but will need to implement your own API routes.\n\n### How do I customize the file size limit?\n\n```typescript\nimport { MAX_FILE_SIZE } from \"@fydemy/cms\";\n// Default is 10MB, you can check this constant\n```\n\nTo change it, you'll need to implement your own validation layer.\n\n### Does it support images?\n\nYes! The package includes file upload functionality. Images can be uploaded and stored in `/public/uploads` (local) or via GitHub API (production).\n\n### How do I backup my content?\n\nSince content is stored in your GitHub repository (in production), it's automatically backed up with full version history. In development, the `/public/content` directory can be committed to git.\n\n### What about rate limiting in production?\n\nThe built-in rate limiter is memory-based and resets on server restart. For production with multiple instances, consider implementing Redis-based rate limiting.\n\n### Can I add more admin users?\n\nCurrently, the package supports a single admin user via environment variables. For multi-user support, you'd need to implement a custom authentication layer.\n\n## Example Admin UI\n\nCheck the `/apps/dev` directory in this repository for a complete example with:\n\n- Login page\n- Admin dashboard\n- File editor\n- File management\n\n## Troubleshooting\n\n### \"CMS_SESSION_SECRET must be at least 32 characters\"\n\nMake sure your session secret is long enough. Generate a secure random string:\n\n```bash\nnode -e \"console.log(require('crypto').randomBytes(32).toString('hex'))\"\n```\n\n### Rate limiting not working across restarts\n\nThe rate limiter is in-memory. For persistent rate limiting, implement Redis storage.\n\n### GitHub API rate limits\n\nGitHub API has rate limits. For high-traffic sites, consider caching content or using a CDN.\n\n## License\n\nMIT\n\n## Contributing\n\nContributions welcome! This is a minimal CMS focused on simplicity and maintainability.\n\nPlease report security vulnerabilities privately to fydemy@gmail.com or via GitHub security advisories.\n\n## Links\n\n- [GitHub Repository](https://github.com/fydemy/cms)\n- [npm Package](https://www.npmjs.com/package/@fydemy/cms)\n- [Report Issues](https://github.com/fydemy/cms/issues)\n- [Security Policy](https://github.com/fydemy/cms/blob/main/SECURITY.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffydemy%2Fcms","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffydemy%2Fcms","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffydemy%2Fcms/lists"}