Liteflow UI

⚠️ Experimental Package: This package is still in development and is provided as an experimental release. Please test thoroughly before using in production environments.

Liteflow UI is a user interface developed for the Liteflow package. You can add it to your Express applications as middleware.

Installation

npm install liteflow-ui

Usage

import express from 'express';
import createLiteflowUIMiddleware from 'liteflow-ui';

const app = express();

// Add middleware
app.use('/liteflow-ui', createLiteflowUIMiddleware({
    path: '/liteflow-ui',        // UI access path (optional)
    username: 'admin',           // Basic auth username (optional)
    password: 'admin123',        // Basic auth password (optional)
    realm: 'Liteflow UI',        // Basic auth realm (optional)
    dbPath: 'workflows.db'       // Database file path (optional)
}));

app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
    console.log('Liteflow UI available at http://localhost:3000/liteflow-ui');
});

Example Application

The package includes an example application. To run the example:

cd middleware/example
npm install
npm start

The example application will be available at:

• Main application: http://localhost:3000
• Liteflow UI: http://localhost:3000/liteflow-ui

Features

• Express middleware integration
• Basic authentication support
• Customizable database path
• TypeScript support
• Customizable UI path

Security Warning

This package uses basic authentication. Before using in production:

• Use strong passwords
• Use HTTPS
• Add additional security measures if needed

Development

To start development:

# Install dependencies
npm install

# Build middleware
npm run build

# Run example application
cd middleware/example
npm install
npm start

Contributing

This is an open source package and we welcome your contributions. To contribute:

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push your branch
5. Create a Pull Request

License

MIT