The Component Generator is a powerful tool designed to accelerate your development workflow by automating the creation of components for your projects. As part of the innovative toolkit showcased in the code generator recipe, it leverages the full potential of Node.js and TypeScript to streamline your coding process.
Before setting up the Component Generator, make sure you have the following prerequisites installed:
- Node.js
- npm (Node Package Manager)
-
Clone the repository to your local machine:
git clone [email protected]:kevin-coyle/ai-recipe-component-generator.git
-
Navigate to the project directory:
cd ai-recipe-component-generator
-
Install the required npm packages:
npm install
To run the Component Generator, you need to configure an environment variable that holds your OpenAI API key.
- Create a
.env
file in the root directory of the project. - Add the following entry to the file:
Replace
OPENAI_API_KEY=your_openai_api_key_here
your_openai_api_key_here
with your actual OpenAI API key.
Please keep your API key secret to prevent unauthorized usage.
Once you have set up your .env
file with the OpenAI API key, you can start the Component Generator with the following command:
npm start
This will launch the application using ts-node
, which allows you to run TypeScript files directly without pre-compilation.
Contributions are welcome! Feel free to fork the repository, make your changes, and create a pull request to merge them into the main branch.
This project is licensed under the MIT License - see the LICENSE.md file for details.