{"id":14155461,"url":"https://github.com/xavimondev/easyreadme","last_synced_at":"2025-04-04T22:01:12.440Z","repository":{"id":200164384,"uuid":"686721173","full_name":"xavimondev/easyreadme","owner":"xavimondev","description":"Easyreadme helps you simplify README creation and generate visually stunning ones with the help of AI and elegant pre-designed templates.","archived":false,"fork":false,"pushed_at":"2025-03-10T01:21:09.000Z","size":2936,"stargazers_count":181,"open_issues_count":0,"forks_count":14,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T21:01:29.725Z","etag":null,"topics":["gpt-3","gpt-3-5-turbo","hacktoberfest","nextjs","openai","readme","readme-generator","readme-template","shadcn-ui","tailwind-css","tiptap-editor","typescript","upstash-redis","vercel-ia","vercel-kv","zustand"],"latest_commit_sha":null,"homepage":"https://easyreadme.app","language":"TypeScript","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/xavimondev.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-03T18:17:32.000Z","updated_at":"2025-03-21T02:28:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"9e970ed2-366b-4b7b-ad60-4de68b968b83","html_url":"https://github.com/xavimondev/easyreadme","commit_stats":null,"previous_names":["xavimondev/easyreadme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavimondev%2Feasyreadme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavimondev%2Feasyreadme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavimondev%2Feasyreadme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xavimondev%2Feasyreadme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xavimondev","download_url":"https://codeload.github.com/xavimondev/easyreadme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256093,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["gpt-3","gpt-3-5-turbo","hacktoberfest","nextjs","openai","readme","readme-generator","readme-template","shadcn-ui","tailwind-css","tiptap-editor","typescript","upstash-redis","vercel-ia","vercel-kv","zustand"],"created_at":"2024-08-17T08:03:24.789Z","updated_at":"2025-04-04T22:01:12.306Z","avatar_url":"https://github.com/xavimondev.png","language":"TypeScript","funding_links":[],"categories":["typescript","Tools \u0026 Utilities"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=https://github.com/xavimondev/easyreadme target=\"_blank\"\u003e\n    \u003cimg src='https://easyreadme.app/banner.jpg' width=\"100%\" alt=\"Banner\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/Next.js-000000?logo=next.js\u0026logoColor=white\" alt=\"Nextjs\" /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/TypeScript-3178C6?logo=typescript\u0026logoColor=white\" alt=\"TypeScript\"  /\u003e\n  \u003cimg src=\"https://img.shields.io/badge/Tailwind%20CSS-0F172A?logo=tailwind-css\u0026logoColor=38BDF9\" alt=\"TailwindCSS\"  /\u003e\n  \u003cimg src=\"https://img.shields.io/github/stars/xavimondev/easyreadme\" alt=\"GitHub Stars\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/contributors/xavimondev/easyreadme\" alt=\"GitHub contributors\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/issues-pr/xavimondev/easyreadme\" alt=\"GitHub pull request\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/license/xavimondev/easyreadme\" alt=\"GitHub License\" /\u003e\n\u003c/p\u003e\n\n\u003cp\u003e\u003cp\u003e\n\u003cp\u003e\u003cp\u003e\n\n## 📌 Overview\n\nEasyreadme is a project that simplifies README creation by generating visually stunning READMEs using pre-designed templates and AI. It supports generating READMEs for JavaScript/TypeScript, Rust, Java, Go, PHP, and Python projects.\nIt relies on a wide range of technologies and libraries including React, Tailwind CSS, Tiptap, OpenAI, and more.\n\n## 🔍 Table of Contents\n\n- [❤️ Features](#features)\n\n- [💻 Stack](#stack)\n\n- [📝 Project Summary](#project-summary)\n\n- [⚙️ Setting Up](#setting-up)\n\n- [🚀 Run Locally](#run-locally)\n\n- [🗺️ Roadmap](#roadmap)\n\n- [🙏 Acknowledgments](#acknowledgments)\n\n- [📄 License](#license)\n\n## Features\n\n[![introduction]](https://github.com/xavimondev/easyreadme/assets/68721455/c17b1b2e-15ce-494d-a5f6-01cd3a33e7d4)\n\n### List of Templates\n\n[![list-templates]](https://github.com/xavimondev/easyreadme/assets/68721455/db0e33dd-a0d5-49b1-95ad-b2750a381f2c)\n\n### Customize README\n\n[![customize]](https://github.com/xavimondev/easyreadme/assets/68721455/5b023d26-8cef-47ac-80e3-14d9625ff9f5)\n\n### AI sections\n\n[![ai-sections]](https://github.com/xavimondev/easyreadme/assets/68721455/75283477-aaa5-46cd-9bc2-7ba51ef48f59)\n\n### Inline Commands\n\n[![inline-commands]](https://github.com/xavimondev/easyreadme/assets/68721455/dcc523c5-5d1a-4694-be14-845c70c578a1)\n\n### Bubble Menu\n\n[![bubble-menu]](https://github.com/xavimondev/easyreadme/assets/68721455/c57eb746-3e38-403f-b47b-faf6b7155596)\n\n### Editable Banner Image URL\n\n[![editable-banner]](https://github.com/xavimondev/easyreadme/assets/68721455/b3ee71e5-3283-40ea-82d9-01f55e2afac8)\n\n### Free AI Credits, Custom API Key, Local Run\n\n[![credits]](https://github.com/xavimondev/easyreadme/assets/68721455/ce5a4bda-34fc-4464-a898-8449c04d2902)\n\n## Stack\n\n- [next](https://nextjs.org/): A framework for building server-rendered React applications.\n- [react](https://reactjs.org/): A JavaScript library for building user interfaces.\n- [typescript](https://www.typescriptlang.org/): A typed superset of JavaScript that compiles to plain JavaScript.\n- [shadcn/ui](https://ui.shadcn.com/): Provides beautifully designed components for UI.\n- [tailwindcss](https://tailwindcss.com/): A utility-first CSS framework for rapid UI development.\n- [vaul](https://github.com/emilkowalski/vaul): An unstyled drawer component for React.\n- [sonner](https://github.com/emilkowalski/sonner): An opinionated toast component for React.\n- [tiptap/core](https://github.com/ueberdosis/tiptap): A highly customizable and extendable rich text editor framework.\n- [swr](https://github.com/vercel/swr): Handles data fetching, caching, and synchronization with the server.\n- [zustand](https://github.com/pmndrs/zustand): A small, fast, and scalable state management library.\n- [lucide](https://lucide.dev/): Beautiful \u0026 consistent icons.\n\n## Project Summary\n\n- [**src**](src): Primary source code directory.\n- [**src/app**](src/app): Contains the main application logic and components.\n- [**src/components**](src/components): Houses reusable UI components.\n- [**src/hooks**](src/hooks): Custom React hooks for managing state and side effects.\n- [**src/lib**](src/lib): Utility functions and helper modules.\n- [**src/services**](src/services): Modules for interacting with external APIs.\n- [**src/styles**](src/styles): Global styles and CSS modules.\n- [**src/types**](src/types): TypeScript type definitions.\n- [**src/utils**](src/utils): Miscellaneous utility functions.\n- [**public**](public): Public directory for static assets and build output.\n\n## Setting Up\n\n#### OPENAI_API_KEY\n\n- Go to the [OpenAI website](https://openai.com/).\n- Sign in to your account or create a new one.\n- Navigate to your [API settings](https://platform.openai.com/account/api-keys).\n- Generate an Secret key.\n- Copy the generated Secret key.\n\n#### GITHUB_ACCESS_TOKEN\n\n- Go to the GitHub website.\n- Sign in to your account or create a new one.\n- Navigate to your account settings.\n- Go to the \"Developer settings\" section.\n- Generate a new personal access token with the necessary permissions.\n\n#### KV_REST_API_URL and KV_REST_API_TOKEN\n\n- Go to the [Vercel website](https://vercel.com/).\n- Sign in to your account or create a new one.\n- Navigate to Storage section.\n- Create a new KV Database.\n- Copy the KV_REST_API_URL and KV_REST_API_TOKEN from under the **.env.local** tab.\n\n## Run Locally\n\n1.Clone the easyreadme repository:\n\n```sh\ngit clone https://github.com/xavimondev/easyreadme\n```\n\n2.Rename the `.env.example` to `.env`:\n\n```bash\nmv .example.env .env\n```\n\n3.Install dependencies:\n\n```bash\n# bun\nbun install\n# pnpm\npnpm install\n# npm\nnpm install\n# yarn\nyarn install\n```\n\n6.Start the development mode:\n\n```bash\n# bun\nbun dev\n# pnpm\npnpm dev\n# npm\nnpm run dev\n# yarn\nyarn dev\n```\n\n\u003e [!IMPORTANT]\n\u003e \n\u003e Despite having a template for NPM Packages, there's still much work to be done and research on how to get the correct types from packages.\n\n## Acknowledgments\n\n- The confetti around the \"Copy Code\" button was created using the [Lucide web](https://github.com/lucide-icons/lucide/blob/main/docs/.vitepress/theme/components/icons/confetti.css) as a reference.\n\n## License\n\nThis project is licensed under the **MIT License** - see the [**MIT License**](https://github.com/xavimondev/easyreadme/blob/main/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxavimondev%2Feasyreadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxavimondev%2Feasyreadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxavimondev%2Feasyreadme/lists"}