A new way of creating captions for social media!
Explore the docs »

View Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Welcome to Captionly!

Captionly is a website that uses Artificial Intelligence (AI) to create personalized Instagram captions for your photos. This makes it easy to create captions that are both creative and engaging, so you can get more likes and followers on your Instagram posts.

To get started, all you need to do is upload a photo to the website and let Captionly do the rest. Our AI will analyze the photo and generate a custom caption that reflects the mood and aesthetic of the photo.

So what are you waiting for? Try Captionly today and start creating captions that will make your Instagram posts stand out from the rest!

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get a free API Key at Cloudinary, PlanetScale, and OpenAI

2. Clone the repo

   git clone https://github.com/keishon104/gpt3-writer-starter.git

3. Install NPM packages

   npm install

4. Enter your API in .env

   OPENAI_API_KEY = 'ENTER YOUR API'
   DATABASE_URL = 'ENTER YOUR API'

5. Insert Cloudinary Information into UploadWidget.js

    cloudName: "CLOUD_NAME",
    uploadPreset: "UPLOAD_PRESET"

(back to top)

Usage

(back to top)

Roadmap

• Add Changelog
• Add back to top links
• Add feedback / learning loop
• Add image to caption

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Keishon Smith - @key_smit

Project Link: https://github.com/keishon104/gpt3-writer-starter/

(back to top)

Acknowledgments

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• GitHub Pages
• Font Awesome
• React Icons

(back to top)