Skip to content

Latest commit

 

History

History
146 lines (86 loc) · 3.68 KB

README.md

File metadata and controls

146 lines (86 loc) · 3.68 KB
Raw

README

Flux API Interface

A simple application that allows you to generate images using the Flux API. This interface lets you input prompts, adjust advanced options, and view and save the generated images directly.

Image1

Table of Contents

  • Prerequisites

  • Installation

  • Configuration

  • Starting the Server

  • Usage

  • Additional Information

  • Troubleshooting

  • Contact

Prerequisites

Ensure you have the following software installed:

Installation

Follow the steps below to install the application:

  1. Clone the Repository Clone the repository to your local machine:
git clone https://github.com/yourusername/flux-api-interface.git

Navigate to the project directory:

cd flux-api-interface
  1. Install Dependencies Install the required npm packages:
npm install

Configuration

  1. Edit the .env File In the root of the project, and replace your_flux_api_key with your actual Flux API key.
API_KEY=your_flux_api_key
  1. Verify Configuration Ensure all variables are correctly set. You can adjust the PORT variable if you wish to run the server on a different port.

Starting the Server

Start the application with the following command:

npm start

If everything is set up correctly, you should see the following message:

Server is running on http://localhost:3000

Usage

  1. Open the Interface Open your web browser and navigate to http://localhost:3000 to use the application.

  2. View Results

  • While the image is being generated, you will see a status message.

  • Once the image is ready, it will be displayed on the page.

  • Click on the image to view it in a larger window.

  • The generated image is automatically saved in the public/images folder.

Additional Information

  • Directory Structure
project-directory/
├── .env
├── server.js
├── routes.js
├── package.json
├── public/
│   ├── index.html
│   └── images/
├── README.md
└── ...

  • Images All generated images are saved in the public/images directory. This directory is automatically created if it doesn't exist.

  • Author and License

    • Author: Hegeneer

    • License: Unlicense (free for everyone, may be used, modified, and sold freely)

  • Sponsor This application is sponsored by hegecoin.com .

Troubleshooting

  • API Errors If you encounter issues generating images, ensure your API key is correct and that you have sufficient credits with the Flux API provider.

  • Port Issues If the server fails to start due to port issues, check that the specified port is not already in use or change the PORT variable in the .env file.

  • Dependencies Ensure all npm dependencies are installed correctly. You may run npm install again if necessary.

Contact

If you have questions or need assistance, please contact me on telegram https://t.me/hegeneer .

Work in progress

I am currently working on enhancing the application with several new features. These include the ability to generate multiple images with a single prompt in one click, save prompts for future use, and a revamped interface for a more streamlined user experience. Additionally, I'm integrating prompt enhancement powered by OpenAI, improved batch processing capabilities, and a history feature for tracking and reusing previous prompts

Enjoy!