:no_entry: [DEPRECATED] Muban

:warning: This version will not receive any future updates, there is a new version

The muban repository and muban-core package will not receive any future updates.

There is a new version in active development at github.com/mubanjs (also called v2), with modern features and a full ecosystem for storybook, testing, hooks, etc.

Muban is a backend-agnostic framework and development setup to enhance server-rendered HTML with TypeScript or Babel components and SCSS stylesheets.

During development, webpack will supply fast compilation and hot reloading, while using Handlebars templates to render everything.

The dist build will generates preview html pages and a js and css bundle that backend developers can use to integrate the pages in their server side templates or CMS of choice.

🎓 Documentation

You can find the full documentation in the /docs folder. Here you will find the full table of contents covering all the subjects required to start on your own Muban project!

• Totally new: If you are new to Muban we suggest to start by reading the preparations guide. This will guide you through the core technologies and the required steps to setup your environment.
• Ready to get started: Once you've completed the preparations you can have a look at the getting started guide. This guide will walk you through all the steps to setup the a new Muban project
• Give me some examples: If you want to dive straight into examples have a look at the guides section of the documentation. This page contains a lot of example situations that hopefully cover all your questions.

🚀 Quick start

If you have all the preparations done and you don't want to read the documentation you can follow these steps to get you started.

1. Get the a copy of the source code using one of the following methods
   • Clone the repository and remove the .git folder.
   • 📦 Download the repository zip file.
2. Install the project dependencies using yarn.
3. Startup the development server using yarn dev.
   • Open your browser at http://localhost:9000.
4. Start editing!

Note: If you need more instructions we suggest you take a look at the full getting started guide!

📚 Ecosystem

| Project | Status | Description | | ---------------------------- | -------------------------------------------------------------------------- | ------------------------------- | | muban-core | | The core functionality of Muban | | muban-storybook | | App framework to integrate Muban in Storybook | | muban-storybook-addon-source | | Show Muban component sources in Storybook | | muban-transition-component | | GSAP transitions for Muban |

📝 License

Muban is released under the MIT License.