Skip to content

Developer Guide

Important: Yumeri is rapidly evolving. Check the latest APIs on GitHub: https://github.com/yumerijs/yumeri

Environment

Create a template project and use "npm run dev" or "yarn dev" to start the dev mode. In dev mode, plugins are loaded from the "plugins" folder first.

Workflow

  1. Create project
  2. Develop plugins
  3. Configure in "config.yml"
  4. Test locally
  5. Deploy

Core concepts

  1. Plugin system – see /en/start/plugin and /en/dev/plugin
  2. Routing – see /en/dev/route
  3. Middleware – see /en/dev/middleware
  4. Events – see /en/dev/event

Tips

  • TypeScript for type‑safety
  • Hot reload in dev
  • Use caching and code‑splitting for performance

Best practices

  • Modular design
  • Clear interfaces
  • Robust error handling
  • Good documentation and tests