Delete README.md
Browse files
README.md
DELETED
|
@@ -1,99 +0,0 @@
|
|
| 1 |
-
# Pollinations Chatbox - Karma.yt Experiment
|
| 2 |
-
|
| 3 |
-
An experimental chat interface powered by Karma.yt, utilizing the advanced AI and image generation capabilities of Pollinations. Explore various AI models for interactive text and image generation, with local storage for seamless conversation continuity. This project is an innovative integration of Pollinations technologies to create a unique and flexible chat experience.
|
| 4 |
-
|
| 5 |
-
## 📧 Contact
|
| 6 |
-
|
| 7 |
-
If you have any questions or suggestions, feel free to reach out to us via email at: **[email protected]**
|
| 8 |
-
|
| 9 |
-
## 🌍 Social Media
|
| 10 |
-
|
| 11 |
-
- **Discord**: [Pollinations Discord](https://discord.gg/k9F7SyTgqn)
|
| 12 |
-
- **WhatsApp**: [WhatsApp Group](https://chat.whatsapp.com/JxQEn2FKDny0DdwkDuzoQR)
|
| 13 |
-
|
| 14 |
-
## 🛠️ Requirements
|
| 15 |
-
|
| 16 |
-
Before running the project locally, make sure you have the following:
|
| 17 |
-
|
| 18 |
-
- **Node.js**: Version 16.x or above
|
| 19 |
-
- **Next.js**: Used for building and rendering the website.
|
| 20 |
-
- **pnpm** (recommended), **npm**, or **bun** for package management.
|
| 21 |
-
|
| 22 |
-
### Installation
|
| 23 |
-
|
| 24 |
-
1. Clone the repository:
|
| 25 |
-
|
| 26 |
-
```bash
|
| 27 |
-
git clone https://github.com/diogo-karma/pollinations-chatbox.git
|
| 28 |
-
cd pollinations-chatbox
|
| 29 |
-
```
|
| 30 |
-
|
| 31 |
-
2. Install dependencies:
|
| 32 |
-
|
| 33 |
-
If using **pnpm** (recommended):
|
| 34 |
-
|
| 35 |
-
```bash
|
| 36 |
-
pnpm install
|
| 37 |
-
```
|
| 38 |
-
|
| 39 |
-
Or using **npm**:
|
| 40 |
-
|
| 41 |
-
```bash
|
| 42 |
-
npm install
|
| 43 |
-
```
|
| 44 |
-
|
| 45 |
-
Or **bun**:
|
| 46 |
-
|
| 47 |
-
```bash
|
| 48 |
-
bun install
|
| 49 |
-
```
|
| 50 |
-
|
| 51 |
-
3. Start the development server:
|
| 52 |
-
|
| 53 |
-
```bash
|
| 54 |
-
pnpm dev
|
| 55 |
-
```
|
| 56 |
-
|
| 57 |
-
Or using **npm**:
|
| 58 |
-
|
| 59 |
-
```bash
|
| 60 |
-
npm run dev
|
| 61 |
-
```
|
| 62 |
-
|
| 63 |
-
Or **bun**:
|
| 64 |
-
|
| 65 |
-
```bash
|
| 66 |
-
bun dev
|
| 67 |
-
```
|
| 68 |
-
|
| 69 |
-
4. Open the app in your browser at [http://localhost:3000](http://localhost:3000).
|
| 70 |
-
|
| 71 |
-
## 🛠️ Folder Structure
|
| 72 |
-
|
| 73 |
-
The project follows the standard Next.js conventions with additional folders for organization:
|
| 74 |
-
|
| 75 |
-
```
|
| 76 |
-
/app # App logic and components, including pages
|
| 77 |
-
/api # API routes for backend interaction
|
| 78 |
-
/components # Reusable UI components
|
| 79 |
-
/ui # Custom UI components built with ShadCN and Tailwind
|
| 80 |
-
/hooks # Custom hooks for additional functionality
|
| 81 |
-
/lib # Helper functions and external libraries
|
| 82 |
-
/public # Public assets like images and fonts
|
| 83 |
-
/styles # Global styles, including Tailwind configuration
|
| 84 |
-
```
|
| 85 |
-
|
| 86 |
-
## 🎨 Design and UX
|
| 87 |
-
|
| 88 |
-
We use **Tailwind CSS** for styling the interface, ensuring a responsive design, while **ShadCN UI** is used for creating a modern and fluid user experience (UX).
|
| 89 |
-
|
| 90 |
-
## 📚 Full Documentation
|
| 91 |
-
|
| 92 |
-
For more details on how the Pollinations technology works, visit the official documentation at [Pollinations.ai](https://pollinations.ai).
|
| 93 |
-
|
| 94 |
-
---
|
| 95 |
-
|
| 96 |
-
Thank you for exploring the **Pollinations (chatbox) Experiment**! Stay tuned for updates and improvements as we continue the development of this application. If you'd like to contribute or discuss new ideas, join us on **Discord** or the **WhatsApp group**!
|
| 97 |
-
|
| 98 |
-
[Pollinations Discord](https://discord.gg/k9F7SyTgqn)
|
| 99 |
-
[WhatsApp Group](https://chat.whatsapp.com/JxQEn2FKDny0DdwkDuzoQR)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|