Skip to content
This repository has been archived by the owner on Aug 2, 2023. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
dhinesh03 committed Nov 11, 2019
2 parents 48ca976 + e5e443d commit bbb3685
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
A boilerplate Mithril application using ES6, Babel, Webpack 4, Sass/SCSS, Webpack dev server hot reload and eslint

### How to use
By using [degit](https://github.com/Rich-Harris/degit)
```shell
npx degit dhinesh03/mithril-starter-kit mithril-starter-kit
or
git clone https://github.com/dhinesh03/mithril-starter-kit
```
or
Expand All @@ -17,6 +20,8 @@ npm start
npm run build
# Compiles the app for production and all compiled files lies on dist dir.
# To deploy an the application simply transfer the dist to a web server's public directory.
npm run build:analyze
# Compiles the app for production and we will have a report and stats for the bundle on dist folder.
```

## Directory Structure:
Expand All @@ -27,8 +32,9 @@ npm run build
│ │ └── *.css.map
│ ├── fonts/
│ ├── images/
│ ├── *.js
│ ├── *.js.map
│ ├── js/
│ │ ├── *.js
│ │ └── *.js.map
│ └── index.html
├── src/ # Application source files
Expand Down Expand Up @@ -56,5 +62,7 @@ npm run build
├── eslintrc.js # ESLint configuration
├── package.json # NPM configuration and scripts
└── webpack.*.js # Webpack configuration
├── .env # Holding environment variables for production mode
├── .env.development # Holding environment variables for development mode
└── config/webpack.*.js # Webpack configuration
```

0 comments on commit bbb3685

Please sign in to comment.