Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/schlomoh/insta_carousel_generator

A fun and interactive TypeScript-based project for generating engaging Instagram carousel posts, powered by OpenAI API. This Instagram post generator is built using the Vite.js build tool for blazing-fast development and efficient building.
https://github.com/schlomoh/insta_carousel_generator

Last synced: 27 days ago
JSON representation

A fun and interactive TypeScript-based project for generating engaging Instagram carousel posts, powered by OpenAI API. This Instagram post generator is built using the Vite.js build tool for blazing-fast development and efficient building.

Awesome Lists containing this project

README

        

# Instagram Carousel Post Generator 🚀📸
[![Deploy site](https://github.com/Schlomoh/insta_carousel_generator/actions/workflows/GH_pages_deployment.yml/badge.svg?branch=main)](https://github.com/Schlomoh/insta_carousel_generator/actions/workflows/GH_pages_deployment.yml)
[![Vite Test](https://github.com/Schlomoh/insta_carousel_generator/actions/workflows/vitest.yml/badge.svg?branch=main)](https://github.com/Schlomoh/insta_carousel_generator/actions/workflows/vitest.yml)

A fun and interactive TypeScript-based project for generating engaging Instagram carousel posts, powered by OpenAI API. This Instagram post generator is built using the Vite.js build tool for blazing-fast development and efficient building.

## 🌟 Features

- Interactive prompts for user input
- Integration with OpenAI API for content generation
- Dynamic carousel post previews
- Export and modify generated posts
- Easily extensible for more customization

## 🛠️ Installation

1. Clone the repository:
```bash
git clone https://github.com/Schlomoh/insta_carousel_generator.git
```

2. Navigate to the project directory:
```bash
cd instagram-carousel-generator
```

3. Install dependencies:
```bash
npm install
```

## 🔧 Configuration

In order to integrate the OpenAI API, create a .env file in the project root and add your `OPENAI_API_KEY` as well as the `OPENAI_CHAT_URL`:

```makefile
OPENAI_API_KEY=your_api_key_here
OPENAI_CHAT_URL=https://api.openai.com/v1/chat
```

Make sure to replace your_api_key_here with your actual OpenAI API key.

## 🚀 Usage

To start the development server, run:
```bash
npm run dev
```

Open your browser and navigate to http://localhost:3005 to start using the Instagram Carousel Post Generator.

## 📦 Build
To build the project for production, run:

```bash
npm run build
```

The built files will be available in the dist folder.

## 🤝 Contributing
Contributions are welcome! Please read the CONTRIBUTING.md file for more details on how to contribute.

## 📃 License
This project is licensed under the MIT License.

Start generating captivating Instagram carousel posts with this interactive generator! Happy posting! 🎉📲