Easyreadme 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. It relies on a wide range of technologies and libraries including React, Tailwind CSS, Tiptap, OpenAI, and more.
- next: A framework for building server-rendered React applications.
- react: A JavaScript library for building user interfaces.
- typescript: A typed superset of JavaScript that compiles to plain JavaScript.
- shadcn/ui: Provides beautifully designed components for UI.
- tailwindcss: A utility-first CSS framework for rapid UI development.
- vaul: An unstyled drawer component for React.
- sonner: An opinionated toast component for React.
- tiptap/core: A highly customizable and extendable rich text editor framework.
- swr: Handles data fetching, caching, and synchronization with the server.
- zustand: A small, fast, and scalable state management library.
- phosphoricons: A flexible icon family for interfaces, diagrams, presentations
- src: Primary source code directory.
- src/app: Contains the main application logic and components.
- src/components: Houses reusable UI components.
- src/hooks: Custom React hooks for managing state and side effects.
- src/lib: Utility functions and helper modules.
- src/services: Modules for interacting with external APIs.
- src/styles: Global styles and CSS modules.
- src/types: TypeScript type definitions.
- src/utils: Miscellaneous utility functions.
- public: Public directory for static assets and build output.
- Go to the OpenAI website.
- Sign in to your account or create a new one.
- Navigate to your API settings.
- Generate an Secret key.
- Copy the generated Secret key.
- Go to the GitHub website.
- Sign in to your account or create a new one.
- Navigate to your account settings.
- Go to the "Developer settings" section.
- Generate a new personal access token with the necessary permissions.
- Go to the Vercel website.
- Sign in to your account or create a new one.
- Navigate to Storage section.
- Create a new KV Database.
- Copy the KV_REST_API_URL and KV_REST_API_TOKEN from under the .env.local tab.
1.Clone the easyreadme repository:
git clone https://github.com/xavimondev/easyreadme2.Install dependencies:
pnpm install
bun install
npm install
yarn install
3.Start the development mode:
pnpm dev
bun dev
npm run dev
yarn dev- Let users create their own templates.
- Extend support for monorepos and libraries.
This project is licensed under the MIT License - see the MIT License file for details.