Sets up a mithril.js project for you, with webpack already configured.
npm i -g create-mithril-app, then type the following:
create-mithril-app <directory> cd <directory> npm install npm run dev
This creates a mithril.js project in the directory specified, install the appopriate modules, and run the skeleton app on port 8020. Open your browser to http://localhost:8020 and you should see a sample mini-app running. It is set up with webpack-dev-server, so when you start editing the code, your browser would reflect the changes instantly.
Table of Contents
I feel mithril.js can benefit from a battery-included tool to set up a project. This tool creates a project with the following:
- webpack-dev-server configured with live reload
- webpack configured with babel
- build pipeline already set up
- a sample Hello World app to kick start
Hopefully this can lower the barrier for new developers to try out mithril, and simplify the mundane task of creating a new project for seasoned developers.
create-mithril-app <directory>- creates a skeleton app with mithril.js and webpack set up in the specified.
create-mithril-app api <directory>- creates a sample backend application in the specified. This sample application can serve API for the mithril.js app.
create-mithril-app download <sample-mithril-app|sample-mithril-api> <version>- explicitly downloads a sample template into the cache. This is usually not necessary, unless you want to use a specific version of the template
create-mithril-app rm <sample-mithril-app|sample-mithril-api>- removes the corresponding sample template from the cache.
- The cache resides at
The skeleton project created by
create-mithril-app has the following structure.
client- the directory for source JS files
public- the directory for static files (html, css etc.)
webpack.dev.js- used by webpack-dev-server when running in dev mode
webpack.build.js- used by webpack to build the production files
package.json- modify this file to configure the name and license of your app
The created project comes with two webpack files, one for development, one for build. They can be configured further to suit your needs. Please be aware we cannot support all these different configurations
npm run build would create the deployable files in the build directory.
create-mithril-app is designed for developing client side applications that access APIs remotely. It can easily integrate with a backend server too. Please see Server setup for the sample API server that comes with this app.
- 2.1.0 - decouples from
sample-mithril-appdependency. User can now fetch the latest
sample-mithril-appwithout needing to update
- 2.0.1 - now uses mithril v2
- 1.0.25 - now supports creating a new app into an empty directory
- 1.0.24 - updated to webpack 4
- 1.0.21 - fixed path not found issue under Linux
- 1.0.14 - now can inject environment variables via .env, .env.development, and .env.production
- 1.0.11 - fixed async/await bug
- 1.0.9 - Added
- 1.0.6 - Added Babel to dev server, and supports spread operator.
- 1.0.5 - Fixed breakpoint debugging in dev mode
- 1.0.3 - Build files are now minified by default, and build pipeline is configurable.
- 1.0.0 - Bumped to 1.0.0 after going through more field testing.
- 0.2.4 - Fully working and supporting dev and build pipeline.
To mithril.js team for building such an interesting framework. To
create-react-app for the inspiration.