Milk Carton

A task runner to create, develop, test, and deploy code

Installation

To install for use in your project:

$ npm install -g milk-carton

Usage

Use these commands in the root of your project

# To view all tasks:
$ milk --help

# To build (alias: b)
$ milk build

# Run a local server for testing (alias: s)
$ milk server

Configuration

You can optionally include a milk.json file in the root of your project to over-ride any of milks default settings. Ensure your milk.json file is valid JSON.

see src/config.js for all available options.

Development

To contribute to milk-carton fork this repository and create a pull request with details regarding your proposed changes. Requirements: yarn

# Install yarn packages
$ yarn install

# To build in development
$ yarn run build --watch

# To build for release
$ yarn run build

Contributors

This project is build by and for Americademy, Inc for use in all products developed for Codeverse

• Americademy - @americademy
• Dave Arel - @davearel

License

/*
 *  The MIT License
 *
 *  Copyright (c) 2016-2018 Americademy, Inc. https://www.americademy.com
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */