Merge pull request #7 from xavimondev/v2

release version 2

.env.example

@@ -1,4 +1,5 @@
 OPENAI_API_KEY=
 GITHUB_ACCESS_TOKEN=
 KV_REST_API_URL=
-KV_REST_API_TOKEN=
+KV_REST_API_TOKEN=
+OLLAMA_URL=http://localhost:11434

.prettierrc.json

@@ -5,5 +5,28 @@
   "semi": false,
   "singleQuote": true,
   "tabWidth": 2,
-  "trailingComma": "none"
+  "trailingComma": "none",
+  "importOrder": [
+    "^(react/(.*)$)|^(react$)",
+    "^(next/(.*)$)|^(next$)",
+    "<THIRD_PARTY_MODULES>",
+    "",
+    "^@/types/(.*)$",
+    "",
+    "@/constants$",
+    "^@/utils/(.*)$",
+    "^@/lib/(.*)$",
+    "^@/services/(.*)$",
+    "@/store$",
+    "^@/hooks/(.*)$",
+    "^@/components/ui/(.*)$",
+    "^@/components/(.*)$",
+    "^@/app/(.*)$",
+    "^@/styles/(.*)$",
+    "",
+    "^[./]"
+  ],
+  "importOrderTypeScriptVersion": "5.2.2",
+  "importOrderParserPlugins": ["typescript", "jsx", "decorators-legacy"],
+  "plugins": ["@ianvs/prettier-plugin-sort-imports"]
 }

README.md

@@ -5,9 +5,11 @@
 </p>
 
 <p align="center">
-  <img src="https://img.shields.io/github/contributors/xavimondev/easyreadme" alt="GitHub contributors" />
+  <img src="https://img.shields.io/badge/Next.js-000000?logo=next.js&logoColor=white" alt="Nextjs" />
+  <img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white" alt="TypeScript"  />
+  <img src="https://img.shields.io/badge/Tailwind%20CSS-0F172A?logo=tailwind-css&logoColor=38BDF9" alt="TailwindCSS"  />
   <img src="https://img.shields.io/github/stars/xavimondev/easyreadme" alt="GitHub Stars" />
-  <img src="https://img.shields.io/github/issues/xavimondev/easyreadme" alt="GitHub issues" />
+  <img src="https://img.shields.io/github/contributors/xavimondev/easyreadme" alt="GitHub contributors" />
   <img src="https://img.shields.io/github/issues-pr/xavimondev/easyreadme" alt="GitHub pull request" />
   <img src="https://img.shields.io/github/license/xavimondev/easyreadme" alt="GitHub License" />
 </p>
@@ -22,17 +24,55 @@ It relies on a wide range of technologies and libraries including React, Tailwin
 
 ## 🔍 Table of Contents
 
-* [💻 Stack](#stack)
+- [❤️ Features](#features)
+
+- [💻 Stack](#stack)
+
+- [📝 Project Summary](#project-summary)
+
+- [⚙️ Setting Up](#setting-up)
+
+- [🚀 Run Locally](#run-locally)
+
+- [🗺️ Roadmap](#roadmap)
+
+- [🙏 Acknowledgments](#acknowledgments)
+
+- [📄 License](#license)
+
+## Features
+
+[![introduction]](https://github.com/xavimondev/easyreadme/assets/68721455/c17b1b2e-15ce-494d-a5f6-01cd3a33e7d4)
+
+### List of Templates
+
+[![list-templates]](https://github.com/xavimondev/easyreadme/assets/68721455/db0e33dd-a0d5-49b1-95ad-b2750a381f2c)
+
+### Customize README
+
+[![customize]](https://github.com/xavimondev/easyreadme/assets/68721455/5b023d26-8cef-47ac-80e3-14d9625ff9f5)
+
+### AI sections
+
+[![ai-sections]](https://github.com/xavimondev/easyreadme/assets/68721455/75283477-aaa5-46cd-9bc2-7ba51ef48f59)
+
+### Inline Commands
+
+[![inline-commands]](https://github.com/xavimondev/easyreadme/assets/68721455/dcc523c5-5d1a-4694-be14-845c70c578a1)
+
+### Bubble Menu
+
+[![bubble-menu]](https://github.com/xavimondev/easyreadme/assets/68721455/c57eb746-3e38-403f-b47b-faf6b7155596)
 
-* [📝 Project Summary](#project-summary)
+### Editable Banner Image URL
 
-* [⚙️ Setting Up](#setting-up)
+[![editable-banner]](https://github.com/xavimondev/easyreadme/assets/68721455/b3ee71e5-3283-40ea-82d9-01f55e2afac8)
 
-* [🚀 Run Locally](#run-locally)
+### Free AI Credits, Custom API Key, Local Run
 
-* [📄 License](#license)
+[![credits]](https://github.com/xavimondev/easyreadme/assets/68721455/ce5a4bda-34fc-4464-a898-8449c04d2902)
 
-## 💻 Stack
+## Stack
 
 - [next](https://nextjs.org/): A framework for building server-rendered React applications.
 - [react](https://reactjs.org/): A JavaScript library for building user interfaces.
@@ -44,9 +84,9 @@ It relies on a wide range of technologies and libraries including React, Tailwin
 - [tiptap/core](https://github.com/ueberdosis/tiptap): A highly customizable and extendable rich text editor framework.
 - [swr](https://github.com/vercel/swr): Handles data fetching, caching, and synchronization with the server.
 - [zustand](https://github.com/pmndrs/zustand): A small, fast, and scalable state management library.
-- [phosphoricons](https://phosphoricons.com/): A flexible icon family for interfaces, diagrams, presentations
+- [lucide](https://lucide.dev/): Beautiful & consistent icons.
 
-## 📝 Project Summary
+## Project Summary
 
 - [**src**](src): Primary source code directory.
 - [**src/app**](src/app): Contains the main application logic and components.
@@ -59,67 +99,91 @@ It relies on a wide range of technologies and libraries including React, Tailwin
 - [**src/utils**](src/utils): Miscellaneous utility functions.
 - [**public**](public): Public directory for static assets and build output.
 
-## ⚙️ Setting Up
+## Setting Up
 
 #### OPENAI_API_KEY
+
 - Go to the [OpenAI website](https://openai.com/).
 - Sign in to your account or create a new one.
 - Navigate to your [API settings](https://platform.openai.com/account/api-keys).
 - Generate an Secret key.
 - Copy the generated Secret key.
 
 #### GITHUB_ACCESS_TOKEN
+
 - 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.
 
 #### KV_REST_API_URL and KV_REST_API_TOKEN
+
 - Go to the [Vercel website](https://vercel.com/).
 - 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.
+- Copy the KV_REST_API_URL and KV_REST_API_TOKEN from under the **.env.local** tab.
 
-## 🚀 Run Locally
+#### OLLAMA_URL
+
+- Download [Ollama](https://ollama.com/download) and have it running.
+- If your instance of Ollama is not running on the default ip-address and port, change the variable in the .env.example file to fit your usecase
+
+## Run Locally
 
 1.Clone the easyreadme repository:
 
 ```sh
 git clone https://github.com/xavimondev/easyreadme
 ```
 
-2.Install dependencies:
+2.Rename the `.env.example` to `.env`:
 
 ```bash
-pnpm install
+mv .example.env .env
+```
 
-bun install
+3.Install dependencies:
 
+```bash
+# bun
+bun install
+# pnpm
+pnpm install
+# npm
 npm install
-
+# yarn
 yarn install
-
 ```
 
-3.Start the development mode:
+6.Start the development mode:
 
 ```bash
-pnpm dev
-
+# bun
 bun dev
-
+# pnpm
+pnpm dev
+# npm
 npm run dev
-
+# yarn
 yarn dev
 ```
 
-## 🗺️ Roadmap
+> [!IMPORTANT]
+> 
+> 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.
+
+## Roadmap
+
+- [ ] **Add support for more programming languages.**
+- [ ] **Add "with emojis" option.**
+
+## Acknowledgments
 
-- [ ] **Let users create their own templates.**
-- [ ] **Extend support for monorepos and libraries.**
+- The sparkles animation were taken from this [great resource](https://www.joshwcomeau.com/react/animated-sparkles-in-react/) created by **Josh W. Comeau**
+- 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.
 
-## 📄 License
+## License
 
 This project is licensed under the **MIT License** - see the [**MIT License**](https://github.com/xavimondev/easyreadme/blob/main/LICENSE) file for details.

next.config.js

@@ -1,4 +1,14 @@
 /** @type {import('next').NextConfig} */
-const nextConfig = {}
+const nextConfig = {
+  async redirects() {
+    return [
+      {
+        "source": "/git",
+        "destination": "https://github.com/xavimondev/easyreadme",
+        "permanent": true
+      }
+    ]
+  }
+}
 
 module.exports = nextConfig

package.json

@@ -1,7 +1,7 @@
 {
   "name": "easyreadme",
   "description": "Easyreadme helps you simplify README creation and generate visually stunning ones with the help of IA and elegant pre-designed templates.",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -12,61 +12,73 @@
     "prettier:check": "npx prettier . --write"
   },
   "dependencies": {
-    "@radix-ui/react-dropdown-menu": "2.0.6",
+    "@radix-ui/react-dialog": "1.0.5",
     "@radix-ui/react-hover-card": "1.0.7",
-    "@radix-ui/react-scroll-area": "1.0.4",
+    "@radix-ui/react-label": "2.0.2",
+    "@radix-ui/react-popover": "1.0.7",
+    "@radix-ui/react-scroll-area": "1.0.5",
     "@radix-ui/react-separator": "1.0.3",
     "@radix-ui/react-slot": "1.0.2",
     "@radix-ui/react-tabs": "1.0.4",
-    "@tiptap/core": "2.1.8",
-    "@tiptap/extension-code-block": "2.1.11",
-    "@tiptap/extension-heading": "2.1.8",
-    "@tiptap/extension-image": "2.1.8",
-    "@tiptap/extension-link": "2.1.8",
-    "@tiptap/extension-paragraph": "2.1.12",
-    "@tiptap/extension-table": "2.1.8",
-    "@tiptap/extension-table-cell": "2.1.8",
-    "@tiptap/extension-table-header": "2.1.8",
-    "@tiptap/extension-table-row": "2.1.8",
-    "@tiptap/extension-task-item": "2.1.8",
-    "@tiptap/extension-task-list": "2.1.8",
-    "@tiptap/extension-text-align": "2.1.8",
-    "@tiptap/pm": "2.1.8",
-    "@tiptap/react": "2.1.8",
-    "@tiptap/starter-kit": "2.1.8",
-    "@types/node": "20.5.9",
-    "@types/react": "18.2.21",
-    "@types/react-dom": "18.2.7",
-    "@upstash/ratelimit": "0.4.4",
-    "@vercel/analytics": "1.0.2",
-    "@vercel/kv": "0.2.3",
+    "@radix-ui/react-tooltip": "1.0.7",
+    "@tiptap/core": "2.2.4",
+    "@tiptap/extension-code-block-lowlight": "2.2.4",
+    "@tiptap/extension-heading": "2.2.4",
+    "@tiptap/extension-image": "2.2.4",
+    "@tiptap/extension-link": "2.2.4",
+    "@tiptap/extension-paragraph": "2.2.4",
+    "@tiptap/extension-placeholder": "2.2.4",
+    "@tiptap/extension-table": "2.2.4",
+    "@tiptap/extension-table-cell": "2.2.4",
+    "@tiptap/extension-table-header": "2.2.4",
+    "@tiptap/extension-table-row": "2.2.4",
+    "@tiptap/extension-task-item": "2.2.4",
+    "@tiptap/extension-task-list": "2.2.4",
+    "@tiptap/extension-text": "2.2.4",
+    "@tiptap/extension-text-align": "2.2.4",
+    "@tiptap/extension-underline": "2.2.4",
+    "@tiptap/pm": "2.2.4",
+    "@tiptap/react": "2.2.4",
+    "@tiptap/starter-kit": "2.2.4",
+    "@tiptap/suggestion": "2.2.4",
+    "@types/node": "20.11.16",
+    "@types/react": "18.2.51",
+    "@types/react-dom": "18.2.18",
+    "@upstash/ratelimit": "1.0.1",
+    "@vercel/analytics": "1.2.2",
+    "@vercel/kv": "1.0.1",
     "ai": "2.2.12",
-    "autoprefixer": "10.4.15",
+    "autoprefixer": "10.4.17",
     "class-variance-authority": "0.7.0",
-    "clsx": "2.0.0",
-    "eslint-config-next": "13.4.19",
-    "highlight.js": "11.8.0",
-    "lowlight": "3.0.0",
-    "next": "13.4.19",
-    "next-themes": "0.2.1",
+    "clsx": "2.1.0",
+    "cmdk": "0.2.1",
+    "eslint-config-next": "14.1.0",
+    "geist": "1.3.0",
+    "highlight.js": "11.9.0",
+    "lowlight": "3.1.0",
+    "lucide-react": "0.321.0",
+    "next": "14.1.0",
+    "node-html-markdown": "1.3.0",
     "openai": "4.7.1",
-    "postcss": "8.4.31",
+    "postcss": "8.4.33",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "react-lowlight": "3.0.0",
-    "sonner": "1.0.3",
+    "sonner": "1.4.0",
     "swr": "2.2.4",
-    "tailwind-merge": "1.14.0",
+    "tailwind-merge": "2.2.1",
     "tailwind-scrollbar-hide": "1.1.7",
-    "tailwindcss": "3.3.3",
-    "tiptap-markdown": "0.8.2",
+    "tailwindcss": "3.4.1",
+    "tippy.js": "6.3.7",
+    "tiptap-extension-auto-joiner": "0.1.1",
+    "tiptap-markdown": "0.8.9",
     "typescript": "5.2.2",
-    "use-debounce": "10.0.0",
-    "vaul": "0.6.7",
-    "zustand": "4.4.1"
+    "vaul": "0.9.0",
+    "zod": "3.22.4",
+    "zustand": "4.5.2"
   },
   "devDependencies": {
-    "@tailwindcss/typography": "0.5.9",
+    "@ianvs/prettier-plugin-sort-imports": "4.1.1",
+    "@tailwindcss/typography": "0.5.10",
     "@typescript-eslint/eslint-plugin": "6.6.0",
     "@typescript-eslint/parser": "6.6.0",
     "eslint": "8.48.0",