├── license └── readme.md /license: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) CJ Patoilo 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | Website Boilerplate - A super simple boilerplate project for websites. 2 | 3 | > A super simple boilerplate project for websites. 4 | 5 | [![Travis Status](https://travis-ci.org/cjpatoilo/website-cli.svg?branch=master)](https://travis-ci.org/cjpatoilo/website-cli?branch=master) 6 | [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/qoj1daayugnrntqa?svg=true)](https://ci.appveyor.com/project/cjpatoilo/website-cli) 7 | [![Codacy Status](https://img.shields.io/codacy/grade/c46be084d6844c3891d086eee66d6464/master.svg)](https://www.codacy.com/app/cjpatoilo/website-cli/dashboard) 8 | [![Dependencies Status](https://david-dm.org/cjpatoilo/website-cli.svg)](https://david-dm.org/cjpatoilo/website-cli) 9 | [![Version Status](https://badge.fury.io/js/website-cli.svg)](https://www.npmjs.com/package/website-cli) 10 | [![Download Status](https://img.shields.io/npm/dt/website-cli.svg)](https://www.npmjs.com/package/website-cli) 11 | [![Gitter Chat](https://img.shields.io/badge/gitter-join_the_chat-4cc61e.svg)](https://gitter.im/cjpatoilo/website-boilerplate) 12 | 13 | 14 | ## Why it's awesome? 15 | 16 | Website Boilerplate provides a expressive boilerplate for a fast starting point. 17 | 18 | 19 | ## Install 20 | 21 | ```sh 22 | $ npm install -g website-cli 23 | ``` 24 | 25 | *NOTE: Install this npm package with `-g` or `--global` to global use.* 26 | 27 | 28 | ## Usage 29 | 30 | Create a new app using the command `website init`, then install dependencies and run with `npm start`. 31 | 32 | ```sh 33 | $ website init new_website 34 | $ cd new_website 35 | $ npm start 36 | ``` 37 | 38 | 39 | ## Contributing 40 | 41 | Want to contribute? Follow these [recommendations](https://github.com/cjpatoilo/website-cli/blob/master/.github/contributing.md). 42 | 43 | 44 | ## License 45 | 46 | Designed with ♥ by [CJ Patoilo](http://twitter.com/cjpatoilo). Licensed under the [MIT License](http://cjpatoilo.mit-license.org). 47 | --------------------------------------------------------------------------------