https://github.com/rumenpetrov/ai-playground

Learning application for trying out AI-related features
https://github.com/rumenpetrov/ai-playground

Last synced: about 1 month ago
JSON representation

Learning application for trying out AI-related features

• Host: GitHub
• URL: https://github.com/rumenpetrov/ai-playground
• Owner: rumenpetrov
• Created: 2024-03-29T07:45:40.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-10T15:08:56.000Z (9 months ago)
• Last Synced: 2024-07-25T12:39:27.601Z (5 months ago)
• Language: TypeScript
• Size: 2.68 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [WIP] AI playground

> This project is currently a work in progress. It's actively being developed, and features may change frequently.

Learning application for trying out AI-related features and building simple REST API.

### Software requirements

* docker and compose 24+

### Hardware requirements

> ⚠️ **Warning**

> Running AI models locally is resource intensive task. Your machine could run out of resources. Make sure you have **at least 8GB of free RAM**, **15GB free storage space** (for LLMs) and your CPU doesn't running any other heavy tasks.

## Initial setup (for local development)

> 🛑 **Important**

> This is not intended for production. Run this on your machine only.

1. Create the environment variables file and set all the required values

```sh

$ cp .env.example .env

```

2. Start the application

```sh

$ docker-compose up

```

### Services

| Service  | Port |

|----------|------|

| localai  | 8080 |

| app | 4321 |

## Objectives checklist

#### Must

* [x] Initial setup for full-stack application

* [x] REST API for interacting with AI models which are running locally

* [x] Serverless database integration

* [x] Passwordless authentication using Github (Social login)

* [x] Add UI framework(s) for client-side interaction

* [x] Add UI library

* [x] Logic for public and private pages

* [x] Develop UIs and page structure

* [x] Private AI chat page

* [x] CRUD operations for a resource in the app and in the REST API

#### Nice to have

* [x] Conversation history - AI takes in consideration previous questions

* [ ] Stream responses - Display each piece of assistants answer while it is generating it

* [ ] Generate image with prompt

* [ ] Passwordless authentication using [passkeys](https://passkeys.dev/)

## Technology stack

* [Node.js](https://nodejs.org/en)

* [Astro](https://astro.build/)

* [LocalAI](https://localai.io/)

* [Xata](https://xata.io)

* [Auth.js](https://authjs.dev/)

* [React](https://react.dev/)

* [Shadcn UI](https://ui.shadcn.com/)

* [Radix UI](https://www.radix-ui.com/)

* [tailwindcss](https://tailwindcss.com/)