liferay-openai-demo-wizard

KO | EN

gitlite — search

#javascript #python #typescript #go #android #rust #deep-learning #linux #awesome #cli #awesome-list #mcp #ios #open-source

liferay-openai-demo-wizard

(★ 16)

No description available.

liferay-openai-demo-wizard Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Liferay OpenAI Content Creation Wizard

With this application, creating content within Liferay is a breeze!

Consider this scenario: You can create 15 products across 5 categories in just 35 seconds with a single prompt from you. The magic happens with integrating OpenAI's API for content creation and Liferay's APIs for seamless storage based on your prompts.

Utilizing this OpenAI Wizard doesn't just speed up content creation, which many of us are already doing with AI. It goes the extra mile by seamlessly loading it into Liferay through Liferay's Extensive Headless APIs. Big kudos to Steven Lu, who helped identify the potential to optimize the time spent on setting up commerce products, categories, and SKUs through Liferay's Headless APIs.
  
![AIWizard-Screenshot](https://github.com/weskempa-liferay/liferay-openai-demo-wizard/assets/68334638/eafd4327-492c-4fcf-81e8-2d3abfa9f8f7)

## The Liferay Content Wizard currently supports generating these asset types:

- **Accounts**
- **Blogs with Images**
- **Taxonomy with Category Structure**
- **Multilingual FAQs**
- **Generation of Images within Documents and Media with a choice of dimensions and quality**
- **Knowledge Base Folders and Articles**
- **Message Board Sections, Threads, and Messages**
- **Multilingual News Articles with Images**
- **Data for Custom Liferay Objects**
- **Organization Structures**
- **Page Hierarchies (AI Generation and File Upload)**
- **Commerce Categories and Products with Images (AI Generation and File Upload)**
- **Users (AI Generation and File Upload)**
- **User Groups**
- **Warehouses with Latitude and Longitude**
- **Wiki Nodes and Pages**

As we move forward, expect more options and deeper integrations for content types.

> [!TIP]
> Frequent updates are expected so it is recommended that you update often.

![Wizard Dashboard](https://github.com/weskempa-liferay/liferay-openai-demo-wizard/assets/68334638/5f4f6f98-24c5-4785-8ac8-da12b75661da)

![287095500-3d733f48-a6cc-48e6-af4c-b0578542befa](https://github.com/weskempa-liferay/liferay-openai-demo-wizard/assets/68334638/de136608-8e95-4a74-bc16-08506570d7b9)

![287095038-7b60a262-e9af-47b4-bbae-7b58d30ee367](https://github.com/weskempa-liferay/liferay-openai-demo-wizard/assets/68334638/e7ed2ee8-a369-41da-aae2-deccf4c97b48)

Technologies used:

- [OpenAI API](https://openai.com/api/)
- [Node.js](https://nodejs.org/en/)
- [Next.js](https://nextjs.org/)
- [React](https://reactjs.org/)
- [TailwindCSS](https://tailwindcss.com/)
- [Highlight.js](https://highlightjs.org/)

## Authentication

You have two options of authentication using Liferay Portal

1. Basic
2. OAuth2

The **Basic** authentication is ideal for localhost, dev, staging environments and the authentication method is using **email** and **password**, you must have sufficient permissions to consume the APIs used on the target asset.

**OAuth2** is recommended for production environments, especially if you are using Liferay SaaS, as basic authentication is disabled by default.

You will need to enable the following scopes to use the **openai-demo-wizard**:

- Liferay.Headless.Admin.Taxonomy.everything
- Liferay.Headless.Admin.User.everything
- Liferay.Headless.Admin.Workflow.everything
- Liferay.Headless.Commerce.Admin.Account.everything
- Liferay.Headless.Commerce.Admin.Catalog.everything
- Liferay.Headless.Delivery.everything
- Liferay.Headless.Site.everything

## Setup

1. If you don’t have Node.js installed, [install it from here](https://nodejs.org/en/)

1. Clone this repository

1. Navigate into the project directory

```bash
cd liferay-openai-demo-wizard
```

1. Install the requirements

```bash
npm install
```

1. Run the app

```bash
npm run dev
```

You should now be able to access the app at [http://localhost:3000](http://localhost:3000).

> [!TIP]
> If you are accessing a local Liferay instance through localhost and have issues with getting the configuration to connect, using "http://127.0.0.1:8080" might solve the connection issue. Some nodejs or axios versions have known issues for calling localhost.

## Deployment

Configuration for the application is now done through the UI. Use the gear icon in the lower right of the screen to set your environment properties.

## Deploy to Liferay PaaS

1. Build the app locally:

```bash
npm run build
```

2. Deploy the app to Liferay PaaS using the `lcp deploy` command. Make sure your Liferay PaaS environment has enough resources.

```bash
lcp deploy
```

> [!TIP]
> After your first deployment, it may take 30 minutes or more for the network to start and the app to become available.
> The `lcp deploy` command might not exit normally. Once you confirm the app is up and running, you can stop the process.

---

> [!WARNING]
> Never use personal information, passwords, or sensitive data for generative AI prompts.

> [!IMPORTANT]
> This is a personal project not directly supported by Liferay Inc.

> [!TIP]
> Your feedback and suggestions are useful to us. Please share your ideas for improvements!

# Let's build great things!

liferay-openai-demo-wizard

liferay-openai-demo-wizard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

liferay-openai-demo-wizard

liferay-openai-demo-wizard Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README