Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hqasmei/captionAI
AI generated captions for your images.
https://github.com/hqasmei/captionAI
nextjs redis tailwindcss typescript upstash vercel
Last synced: 8 days ago
JSON representation
AI generated captions for your images.
- Host: GitHub
- URL: https://github.com/hqasmei/captionAI
- Owner: hqasmei
- License: mit
- Created: 2023-03-20T05:34:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-03-22T19:01:41.000Z (over 1 year ago)
- Last Synced: 2024-08-13T07:17:03.729Z (4 months ago)
- Topics: nextjs, redis, tailwindcss, typescript, upstash, vercel
- Language: TypeScript
- Homepage: https://captionai.vercel.app/
- Size: 3.83 MB
- Stars: 42
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - hqasmei/captionAI - AI generated captions for your images. (TypeScript)
README
# [CaptionAI](https://captionai.vercel.app/)
This project creates captions for photos using AI.
[](https://captionai.vercel.app/)
## How it works
Developed this using [this template.](https://github.com/Nutlope/restorePhotos/tree/1c5c8ac4f52a08f68a3091d3b21be8a65aef71f2)
It uses an ML model from salesforce called [BLIP](https://github.com/salesforce/BLIP) on [Replicate](https://replicate.com/) to convert images into text. This application gives you the ability to upload any photo, which will send it through this ML Model using a Next.js API route, and return your caption.
## Running Locally
### Cloning the repository the local machine.
```bash
git clone
```
### Creating a account on Replicate to get an API key.
1. Go to [Replicate](https://replicate.com/) to make an account.
2. Click on your profile picture in the top right corner, and click on "Dashboard".
3. Click on "Account" in the navbar. And, here you can find your API token, copy it.
### Storing API key in .env file.
Create a file in root directory of project with env. And store your API key in it, as shown in the .example.env file.
If you'd also like to do rate limiting, create an account on UpStash, create a Redis database, and populate the two environment variables in `.env` as well. If you don't want to do rate limiting, you don't need to make any changes.
### Installing the dependencies.
```bash
npm install
```
### Running the application.
Then, run the application in the command line and it will be available at `http://localhost:3000`.
```bash
npm run dev
```
## Deploy
When deploying on Vercel also include the Environmentable Variables.
## Powered by
This example is powered by the following 3 services:
- [Replicate](https://replicate.com) (AI API)
- [Upload](https://upload.io) (storage)
- [Upstash Redis](https://docs.upstash.com/redis) (Rate Limiting)
- [Vercel](https://vercel.com) (hosting, serverless functions, analytics)