Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ A GUI tool that opens in your browser. Design, test, and export chatbot conversa

```bash
# Install as development dependency
npm install --save-dev chatbot-flow-editor
npm install --save-dev @enumura/chatbot-flow-editor

# Launch the visual editor
npx chatbot-flow-editor
npx @enumura/chatbot-flow-editor
```

Your browser will automatically open with the visual flow editor at `http://localhost:3001`.
Expand All @@ -20,8 +20,8 @@ Your browser will automatically open with the visual flow editor at `http://loca

### Method 1: Using npx
```bash
npm install --save-dev chatbot-flow-editor
npx chatbot-flow-editor
npm install --save-dev @enumura/chatbot-flow-editor
npx @enumura/chatbot-flow-editor
```

### Method 2: Add to your project scripts
Expand All @@ -41,7 +41,7 @@ npm run design-flows

### Method 3: Global installation
```bash
npm install -g chatbot-flow-editor
npm install -g @enumura/chatbot-flow-editor
chatbot-flow-editor
```

Expand All @@ -65,7 +65,7 @@ chatbot-flow-editor version # Show version

## How to Use

1. **Launch**: Run `npx chatbot-flow-editor`
1. **Launch**: Run `npx @enumura/chatbot-flow-editor`
2. **Create Nodes**: Click "Add Node" to create conversation points
3. **Edit Content**: Click any node to modify its content and options
4. **Test Flow**: Use the chat preview to simulate user interactions
Expand All @@ -76,10 +76,10 @@ chatbot-flow-editor version # Show version

```bash
# In your chatbot project directory
npm install --save-dev chatbot-flow-editor
npm install --save-dev @enumura/chatbot-flow-editor

# Design your conversation flows
npx chatbot-flow-editor
npx @enumura/chatbot-flow-editor

# Export the flow as JSON
# → Use the exported JSON in your chatbot application
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ src/

- [User Documentation](https://enumura1.github.io/chatbot-flow-editor/)
- [GitHub Repository](https://github.com/enumura1/chatbot-flow-editor)
- [npm Package](https://www.npmjs.com/package/chatbot-flow-editor)
- [npm Package](https://www.npmjs.com/package/@enumura/chatbot-flow-editor)
6 changes: 3 additions & 3 deletions docs/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@ Get started in less than 2 minutes:

```bash
# Install as dev dependency
npm install --save-dev chatbot-flow-editor
npm install --save-dev @enumura/chatbot-flow-editor

# Launch the visual editor
npx chatbot-flow-editor
npx @enumura/chatbot-flow-editor
```

Your browser will automatically open at `http://localhost:3001` with the visual flow editor.

## Your First Flow

1. **Launch the Editor**: Run `npx chatbot-flow-editor`
1. **Launch the Editor**: Run `npx @enumura/chatbot-flow-editor`
2. **Create a Node**: Click "Add Node" to create your first conversation point
3. **Edit Content**: Click the node to modify its message and add response options
4. **Test the Flow**: Use the chat preview on the right to simulate conversations
Expand Down
26 changes: 13 additions & 13 deletions docs/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ node --version
The fastest way to get started. No installation required:

```bash
npx chatbot-flow-editor
npx @enumura/chatbot-flow-editor
```

This command:
Expand All @@ -37,16 +37,16 @@ Install as a development dependency in your project:

```bash
# Using npm
npm install --save-dev chatbot-flow-editor
npm install --save-dev @enumura/chatbot-flow-editor

# Using yarn
yarn add --dev chatbot-flow-editor
yarn add --dev @enumura/chatbot-flow-editor
```

Then run:
```bash
# Using npm
npx chatbot-flow-editor
npx @enumura/chatbot-flow-editor

# Using yarn
yarn chatbot-flow-editor
Expand Down Expand Up @@ -77,7 +77,7 @@ npm run chatbot-editor
### Basic Usage
```bash
# For quick testing
npx chatbot-flow-editor
npx @enumura/chatbot-flow-editor

# If installed as dev dependency with scripts configured
npm run design-flows
Expand All @@ -86,18 +86,18 @@ npm run design-flows
### Custom Port
```bash
# Set custom port
PORT=4000 npx chatbot-flow-editor
PORT=4000 npx @enumura/chatbot-flow-editor

# Or use environment variable
export PORT=4000
npx chatbot-flow-editor
npx @enumura/chatbot-flow-editor
```

### Available Commands
```bash
npx chatbot-flow-editor # Start the editor (for quick testing)
npx @enumura/chatbot-flow-editor # Start the editor (for quick testing)
npm run design-flows # Start the editor (if configured in scripts)
PORT=4000 npx chatbot-flow-editor # Start with custom port
PORT=4000 npx @enumura/chatbot-flow-editor # Start with custom port
```

## Verify Installation
Expand Down Expand Up @@ -185,19 +185,19 @@ npm run dev
### Remove Development Dependency
```bash
# Using npm
npm uninstall chatbot-flow-editor
npm uninstall @enumura/chatbot-flow-editor

# Using yarn
yarn remove chatbot-flow-editor
yarn remove @enumura/chatbot-flow-editor
```

### Remove Global Installation
```bash
# Using npm
npm uninstall -g chatbot-flow-editor
npm uninstall -g @enumura/chatbot-flow-editor

# Using yarn
yarn global remove chatbot-flow-editor
yarn global remove @enumura/chatbot-flow-editor
```

## Next Steps
Expand Down
4 changes: 2 additions & 2 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ const config: Config = {
items: [
{
label: 'npm Package',
href: 'https://www.npmjs.com/package/chatbot-flow-editor',
href: 'https://www.npmjs.com/package/@enumura/chatbot-flow-editor',
},
],
},
Expand Down Expand Up @@ -186,7 +186,7 @@ const config: Config = {
},
{
label: 'npm',
href: 'https://www.npmjs.com/package/chatbot-flow-editor',
href: 'https://www.npmjs.com/package/@enumura/chatbot-flow-editor',
},
{
label: 'Changelog',
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function HomepageHeader() {

const handleCopy = async () => {
try {
await navigator.clipboard.writeText('npx chatbot-flow-editor');
await navigator.clipboard.writeText('npx @enumura/chatbot-flow-editor');
setIsCopied(true);
// Display end
setTimeout(() => {
Expand All @@ -40,7 +40,7 @@ function HomepageHeader() {
<div className={styles.quickStart}>
<div className={styles.installCommand}>
<span className={styles.commandPrefix}>$</span>
<code>npx chatbot-flow-editor</code>
<code>npx @enumura/chatbot-flow-editor</code>
<button
className={clsx(styles.copyButton, {
[styles.copied]: isCopied
Expand Down
Loading