**
127 | * 🐞 **Report Bugs / Suggest Features:** Found a bug or have an idea? Open an issue on the [GitHub Issues page](https://github.com/webvijayi/CookFast/issues).
128 | * 🤝 **Contribute Code:** Pull requests are welcome! Feel free to fork the repository and submit your improvements.
129 | * 📧 **Contact:** For other inquiries, you can reach out to **care [at] webvijayi [dot] com**.
130 |
131 | ---
132 |
133 | ## 🚀 Deployment
134 |
135 | This application is configured for deployment on platforms like Netlify or Vercel which support Next.js applications with API routes. The code is designed to be easily deployable on platforms like Vercel, Netlify, or your own server.
136 |
137 | ### Netlify Blobs Integration
138 |
139 | CookFast uses Netlify Blobs for storing generated documents in production environments:
140 |
141 | - **Zero Configuration**: Netlify Blobs is automatically configured when deployed on Netlify
142 | - **Persistent Storage**: Documents are stored persistently even through redeployments
143 | - **Local Development**: In local development, files are stored in the `tmp` directory as a fallback
144 | - **High Availability**: Netlify Blobs provides a highly-available, scalable storage solution
145 |
146 | To work with Netlify Blobs locally, you can use the following commands:
147 |
148 | ```bash
149 | # Start Netlify dev environment
150 | npm run netlify:dev
151 |
152 | # List all blobs in the store
153 | npm run netlify:blobs:list
154 |
155 | # Delete a specific blob
156 | npm run netlify:blobs:delete generationResults/YOUR_REQUEST_ID
157 | ```
158 |
159 | For more information about Netlify Blobs, see the [documentation](.docs/netlify-blobs.md).
160 |
161 | ---
162 |
163 | ## Learn More (Default Next.js Info)
164 |
165 | To learn more about the underlying Next.js framework, take a look at the following resources:
166 |
167 | - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
168 | - [Learn Next.js](https://nextjs.org/learn-pages-router) - an interactive Next.js tutorial.
169 |
--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Security Policy
2 |
3 | ## Reporting a Vulnerability
4 |
5 | At CookFast, we take security seriously. We appreciate the work of security researchers in helping us maintain a secure application for our users.
6 |
7 | ### How to Report a Vulnerability
8 |
9 | If you believe you've found a security vulnerability in CookFast, please follow these steps:
10 |
11 | 1. **Use GitHub's Private Vulnerability Reporting**: Go to the "Security" tab on our GitHub repository and click on "Report a vulnerability"
12 |
13 | 2. **Alternatively, contact maintainers directly**: If needed, you can email us at Care[at]webvijayi.com and me[at]lokeshmotwani.com with the subject line "CookFast Security Vulnerability"
14 |
15 | ### What to Include in Your Report
16 |
17 | Please include the following details in your vulnerability report:
18 |
19 | - Description of the vulnerability
20 | - Steps to reproduce the issue
21 | - Potential impact of the vulnerability
22 | - Any potential solutions you've identified (optional)
23 |
24 | ### Our Commitment
25 |
26 | We commit to:
27 |
28 | - Responding to security reports within 48 hours
29 | - Keeping reporters updated as we address the issue
30 | - Giving proper credit to security researchers who help us improve our security (unless they prefer to remain anonymous)
31 | - Not taking legal action against those who report vulnerabilities in good faith
32 |
33 | ## Security Measures
34 |
35 | CookFast implements the following security measures:
36 |
37 | - API keys are never stored by the application
38 | - Keys are sent directly to the chosen AI provider for the generation request only
39 | - API key validation happens client-side before submission
40 | - Basic rate limiting is implemented to prevent abuse
41 | - Regular dependency updates to patch known vulnerabilities
42 |
43 | Thank you for helping keep CookFast and its users safe!
44 |
--------------------------------------------------------------------------------
/browserslist:
--------------------------------------------------------------------------------
1 | last 2 versions
2 | > 0.5%
3 | not dead
4 | not IE 11
5 |
--------------------------------------------------------------------------------
/components.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "https://ui.shadcn.com/schema.json",
3 | "style": "default",
4 | "rsc": false,
5 | "tsx": true,
6 | "tailwind": {
7 | "config": "tailwind.config.js",
8 | "css": "src/styles/globals.css",
9 | "baseColor": "neutral",
10 | "cssVariables": true,
11 | "prefix": ""
12 | },
13 | "aliases": {
14 | "components": "@/components",
15 | "utils": "@/lib/utils",
16 | "ui": "@/components/ui",
17 | "lib": "@/lib",
18 | "hooks": "@/hooks"
19 | },
20 | "iconLibrary": "lucide"
21 | }
--------------------------------------------------------------------------------
/deno.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "jsx": "react-jsx",
4 | "jsxImportSource": "https://esm.sh/react@18.2.0"
5 | },
6 | "importMap": {
7 | "imports": {
8 | "react": "https://esm.sh/react@18.2.0",
9 | "react/": "https://esm.sh/react@18.2.0/"
10 | }
11 | }
12 | }
--------------------------------------------------------------------------------
/eslint.config.mjs:
--------------------------------------------------------------------------------
1 | import { dirname } from "path";
2 | import { fileURLToPath } from "url";
3 | import { FlatCompat } from "@eslint/eslintrc";
4 |
5 | const __filename = fileURLToPath(import.meta.url);
6 | const __dirname = dirname(__filename);
7 |
8 | const compat = new FlatCompat({
9 | baseDirectory: __dirname,
10 | });
11 |
12 | const eslintConfig = [
13 | ...compat.extends("next/core-web-vitals", "next/typescript"),
14 | ];
15 |
16 | export default eslintConfig;
17 |
--------------------------------------------------------------------------------
/netlify.toml:
--------------------------------------------------------------------------------
1 | # Netlify build configuration for a Next.js project
2 |
3 | [build]
4 | # Command to build the Next.js application and ensure static assets are properly copied
5 | command = "npm run build && cp -r public/* .next/static/ && cp public/cookfast-og.png .next/"
6 |
7 | # Explicitly set the publish directory for Next.js builds
8 | # Next.js uses .next for its build, but we need to make sure
9 | # static assets from public are also included
10 | publish = ".next"
11 |
12 | # Directory containing serverless functions (API routes)
13 | # Netlify's Next.js runtime automatically detects functions in pages/api.
14 | # functions = "netlify/functions" # Typically not needed for Next.js API routes
15 |
16 | [dev]
17 | # Optional: Settings for local development using Netlify Dev CLI
18 | command = "npm run dev" # Command to start your dev server
19 | port = 3000 # Port your dev server runs on
20 | publish = ".next" # Dev server build directory (if applicable)
21 |
22 | # Plugin for essential Next.js features on Netlify
23 | [[plugins]]
24 | package = "@netlify/plugin-nextjs"
25 |
26 | # Configure paths for functions
27 | [functions]
28 | # Next.js API routes are stored in src/pages/api, but Netlify expects them in netlify/functions
29 | directory = "src/pages/api"
30 | node_bundler = "esbuild"
31 | # Note: Node.js version is set via environment variable in Netlify UI
32 | included_files = ["public/**/*"] # Include public directory for static assets
33 |
34 | # Configure generate-docs as a background function
35 | [functions."generate-docs"]
36 | node_bundler = "esbuild"
37 | background = true
38 | timeout = "900" # 15 minutes for background functions
39 | memory = 1024 # 1GB memory
40 | included_files = ["!node_modules/**/*", "public/**/*"] # Exclude node_modules to reduce bundle size, include public directory
41 |
42 | # Environment variables configuration
43 | [build.environment]
44 | # Set Netlify Blobs context - This variable is automatically set by Netlify but defining it here ensures it's available
45 | NETLIFY_BLOBS_CONTEXT = "production"
46 | # Node version
47 | NODE_VERSION = "18"
48 |
49 | # Edge Function configuration for Open Graph image generation
50 | [[edge_functions]]
51 | function = "og"
52 | path = "/api/og"
53 |
54 | # Handle OPTIONS requests for the OG endpoint (needed for some crawlers)
55 | [[headers]]
56 | for = "/api/og"
57 | [headers.values]
58 | Access-Control-Allow-Origin = "*"
59 | Access-Control-Allow-Methods = "GET, OPTIONS"
60 | Access-Control-Allow-Headers = "Accept-Encoding, Content-Type"
61 | X-Frame-Options = "DENY"
62 | X-Content-Type-Options = "nosniff"
63 | Content-Type = "image/png"
64 | Cache-Control = "public, max-age=300, s-maxage=3600"
65 |
66 | # Fallback rules for OG images if Edge Function fails
67 | [[redirects]]
68 | from = "/api/og-fallback"
69 | to = "/cookfast-og.png"
70 | status = 200
71 | force = true
72 |
73 | # Ensure proper handling of OpenGraph image requests
74 | [[headers]]
75 | for = "/cookfast-og.png"
76 | [headers.values]
77 | Cache-Control = "public, max-age=86400, s-maxage=31536000"
78 | Content-Type = "image/png"
79 |
--------------------------------------------------------------------------------
/netlify/edge-functions/og.tsx:
--------------------------------------------------------------------------------
1 | /// 134 | Get answers to common questions about CookFast. 135 |
136 |{description}
53 |130 | Everything you need to quickly generate comprehensive documentation for your projects 131 |
132 |
162 | {formatJson(log.details)}
163 |
164 | )}
165 | 35 | CookFast makes project documentation simple with just three easy steps. 36 |
37 |{step.description}
51 |10 | Use these guidelines to ensure your Mermaid diagrams render correctly: 11 |
12 | 13 |graph TD (top-down) or graph LR (left-right)graph TD;A --{'>'} B (not A--{'>'}B)A["Multi word"]A --{'>'}|Yes| BsequenceDiagramparticipant A as "System A"A-{'>'}{'>'} B: Messageactivate AstateDiagram-v2[*] for start/end statesStateA --{'>'} StateB: Actionstate StateA {'{'} ... {'}'}erDiagramENTITY1 ||--o{'{'} ENTITY2 : "relationship"|| (exactly one), o{'{'} (zero or many), etc.ganttdateFormat YYYY-MM-DDsection SectionNameTask name : status, startDate, endDate```mermaid and ``` fencesNo valid documentation content was generated or received. Please check the generation logs or try again.
49 |