Companion IO

Intro

An platform to have conversation with a imaginary AI characters by defining the behavior and speaking tone.

Try it out!

1. You can clone & run this repo locally with the following command:

git clone https://github.com/vignesh-gupta/companion-io

2. Then, install the dependencies with your package manager of choice:

npm i
yarn i
pnpm i

3. Copy the .env.example and create a .env file.
4. Follow the instruction to get your own keys from each platform. And replace the dummy text with that key.
5. Finally, run the app locally with any of following command:

npm run dev
yarn dev
pnpm dev

Tech Stack + Features

Frameworks

• Next.js – React framework for building performant apps with the best developer experience
• Clerk: A JavaScript library for user management and authentication.
• Prisma – Typescript-first ORM for Node.js

Platforms

• Vercel – Easily preview & deploy changes with git
• Pinecone – Vector DB provider for Long term Memory of AI.
• Upstash – Fast, Simple and Rubust Serverless Data Platform
• Replicate – AI Model hosting platform

UI

• Tailwind CSS – Utility-first CSS framework for rapid UI development
• Shadcn UI - A Component library to copy and paste component built on top of Tailwind + Radix.
• Lucide – Beautifully simple, pixel-perfect icons

Code Quality

• TypeScript – Static type checker for end-to-end typesafety
• ESLint – Pluggable linter for Next.js & TypeScript

Author

• Vignesh Gupta (@VighneshGupta9)

Thank you!

Hope it is useful. Please do ⭐ the repo. Happy coding!