Skip to content

ivanhardjr/OTUIEditor

 
 

Repository files navigation

License

OTUI Editor is licensed for personal, non-commercial use only. Commercial use, resale, or closed-source redistribution is strictly prohibited. Contributions are welcome via pull requests.

OTUI Builder

Visual editor for OTClient UI files. Example: https://otui.otveterans.net/

Quick Start

1. Install Dependencies

# Install server dependencies
cd server
npm install
cd ..

Or use the convenience script:

npm run install-deps

2. Start the Server

From the root directory:

npm start

Or from the server directory:

cd server
npm start

The server will start on port 3000 by default.

3. Access the Application

  • Local: http://localhost:3000
  • Production: http://otveterans.net (if configured with reverse proxy)

Project Structure

otui/
├── server/              # Express server
│   ├── server.js       # Main server file
│   ├── package.json    # Server dependencies
│   ├── lib/            # Server-side modules
│   └── data/           # User data and sessions
├── OBJS/               # Client-side JavaScript
├── otui_builder.html   # Main HTML file
├── otui_builder.css    # Styles
├── otui_builder.js     # Script loader
└── package.json        # Root package.json (for convenience)

Important Notes

  • Always run npm install in the server/ directory first
  • The server serves both the frontend files and API endpoints
  • Authentication is required to use the application
  • See server/AUTH_SETUP.md for authentication setup
  • See server/DEPLOYMENT.md for deployment instructions

Troubleshooting

If you get "ENOENT" errors:

  1. Make sure you're in the correct directory
  2. Run npm install in the server/ directory
  3. Check that all files are present

If port 3000 is in use:

PORT=3001 npm start

About

Tool to generate new otui files

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 88.7%
  • HTML 5.8%
  • CSS 5.5%