https://github.com/haidra-org/artbot
A front-end GUI for interacting with AI Horde's distributed cluster of Stable Diffusion workers
https://github.com/haidra-org/artbot
ai-art ai-art-generator generative-ai nextjs stable-diffusion typescript
Last synced: 6 months ago
JSON representation
A front-end GUI for interacting with AI Horde's distributed cluster of Stable Diffusion workers
- Host: GitHub
- URL: https://github.com/haidra-org/artbot
- Owner: Haidra-Org
- License: agpl-3.0
- Created: 2024-05-30T17:47:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-11T04:37:26.000Z (7 months ago)
- Last Synced: 2025-04-22T12:12:20.361Z (6 months ago)
- Topics: ai-art, ai-art-generator, generative-ai, nextjs, stable-diffusion, typescript
- Language: TypeScript
- Homepage: https://tinybots.net/artbot
- Size: 7.32 MB
- Stars: 17
- Watchers: 5
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ArtBot
A front-end GUI for interacting with AI Horde's distributed cluster of Stable Diffusion workers.
## Table of Contents
- [Intro](#intro)
- [Setup](#setup)
- [Requirements](#requirements)
- [Installing](#installing)
- [Usage](#usage)
- [Development](#development)
- [Production](#production)
- [Contributions](#contributions)
- [Acknowledgements](#acknowledgements)
## Intro
ArtBot is a front-end web client designed for interacting with the [AI Horde](https://aihorde.net/) open source distributed cluster -- a group of GPUs running Stable Diffusion whose processing time has been kindly donated by an enthusiastic community of volunteers.
ArtBot is built using [Next.js 14](https://nextjs.org/) and [Typescript](https://www.typescriptlang.org/). It uses client-side technologies such as IndexedDB and LocalStorage APIs in order to securely and privately store the AI generated images you've created using the cluster within your own web browser.
## Setup
### Requirements
- node `>= 18.18.0`
- npm `>= 9.5.1`
Most of these steps should be applicable to Linux, MacOS, or Windows environments.
Installing various versions of Node.js on your machine can be tricky. I am a big fan of [nvm](https://github.com/nvm-sh/nvm), which allows you to run multiple isolated versions of Node.js on your machine with ease.
Using `nvm`, you can install Node like this:
```bash
> nvm install v18.18.0
> nvm alias default node
> node -v # Checks which version of Node is currently running
```
### Installing
Once you have your Node.js environment setup, you can clone this repository and install the required packages. Depending on the specs of your machine and speed of your internet connection, installing all packages may take a minute or two.
```bash
> git clone https://github.com/Haidra-Org/artbot.git
> cd artbot
> npm install
```
## Usage
### Development
Alright, you should now be able to run the ArtBot web app! To run in development mode (which uses NextJS's hot reloading feature -- where you can see updates live on the site as you make changes)
```bash
> npm run dev
```
Then, open your browser and visit `http://localhost:3000`, you should now be able to immediately make image requests to the Stable Horde. Head over to `http://localhost:3000/settings` and enter your Stable Horde API key for faster generation times.
### Production
ArtBot is built using [Next.JS's standalone mode](https://nextjs.org/docs/pages/api-reference/next-config-js/output). This outputs the project to `./next/standalone`. The idea is that this folder can be gzipped and uploaded to wherever you need to serve the project.
After running `npm run build`, you'll need to run `npm run postbuild` in order to copy static assets and the public folder (NextJS doesn't automatically do this, as these sorts of things should usually be uploaded to a CDN). If you forget to run the `postbuild` script, ArtBot will be missing images and CSS styles.
```bash
> npm run build
> npm run postbuild # copies public folder
> cd ./next/standalone
> node server.js
```
## Contributions
Contributions are very welcome! General guidelines are as follows:
1. [Fork this repository](https://github.com/Haidra-Org/artbot/fork)
2. Cut a new feature branch. e.g., `> git checkout -b feat/my-cool-new-feature`
3. Make any necessary changes and commit your code! (If possible, use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/))
4. [Open a new pull request](https://github.com/Haidra-Org/artbot/pulls) based on your feature branch.
Let me know if you have any questions. I'm more than happy to help.
## Acknowledgements
ArtBot makes use of a number of resources provided by designers and developers who make their work freely available. Without these tools, ArtBot and many other projects on the Internet would not be able to exist. We are very grateful!
- ["AI free icon" via Flaticon](https://www.flaticon.com/free-icon/ai_2814666?related_id=2814650) - used for the ArtBot logo
- [Next.js](https://nextjs.org/)
- [Statery](https://github.com/hmans/statery) - Simple global state management
- [Tabler Icons](https://tabler-icons.io/)
- [Tailwind CSS](https://tailwindcss.com/)