steffany-martins / imaginuts

ImagiNUTS: A page that you can create images with your mind using Open AI API,

ImagiNUTS

ImagiNUTS is a repository containing a client-side component for an OpenAI-based image generation project. Users can provide a prompt, and the system will generate images based on that prompt.

Preview Project Running

Getting Started

To run this project, follow these steps:

Prerequisites

Before you begin, make sure you have the following installed:

• Node.js (Version 14 or higher)
• npm or yarn package manager

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/Steffany-Martins/ImagiNUTS.git

2. Change to the project directory:

   cd ImagiNUTS

3. Install project dependencies:

   npm install
   # or
   yarn install

Configuration

Before running the project, you need to configure your OpenAI API key. You can provide your API key either via environment variables or as part of the project's configuration.

Environment Variable

Create a .env.local file in the project root directory and add your OpenAI API key:

API_KEY=your-api-key-here

Project Configuration

In the Form.tsx file, make sure the publicRuntimeConfig object is set up correctly:

const apiKey = (typeof publicRuntimeConfig !== 'undefined' && publicRuntimeConfig ? publicRuntimeConfig.apiKey : process.env.API_KEY);

Running the Project

Once you have configured your API key, you can run the project locally using one of the following commands:

• Development mode:

  npm run dev
  # or
  yarn dev

• Build and start in production mode:

  npm run build
  npm start
  # or
  yarn build
  yarn start

The project should now be running locally at http://localhost:3000.

Technologies Used

• React - JavaScript library for building user interfaces.
• Next.js - A React framework for server-rendered applications.
• OpenAI API - Used for generating images based on user prompts.
• Tailwind CSS - A utility-first CSS framework.
• dotenv - Used for managing environment variables.
• Other dependencies as listed in the package.json file.

License

This project is licensed under the MIT License - see the LICENSE file for details.