Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/callmecavs/outset-lib

A boilerplate for vanilla JavaScript libraries.
https://github.com/callmecavs/outset-lib

boilerplate frontend tooling workflow

Last synced: 7 days ago
JSON representation

A boilerplate for vanilla JavaScript libraries.

Host: GitHub
URL: https://github.com/callmecavs/outset-lib
Owner: callmecavs
Created: 2015-11-23T22:43:10.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2017-12-06T20:43:12.000Z (about 7 years ago)
Last Synced: 2024-12-09T05:43:36.116Z (about 1 month ago)
Topics: boilerplate, frontend, tooling, workflow
Language: JavaScript
Homepage:
Size: 61.5 KB
Stars: 5
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# outset-lib

[![outset-lib on NPM](https://img.shields.io/npm/v/outset-lib.svg?style=flat-square)](https://www.npmjs.com/package/outset-lib)

A boilerplate for vanilla JavaScript libraries.

## Features

* **Convenient.** Scaffold a project by running 1 command in your terminal.
* **Customized.** The library name you choose is used to pre-populate the template.
* **Modern.** Write ES6/7 syntax, and let users consume it how they want to (AMD, CommonJS, or script tag).
* **Lean.** Distribution files support users with tree-shaking bundlers (and the `package.json` is setup correctly).

## Install

Using NPM, install outset-lib globally.

```bash
$ npm install outset-lib -g
```

## Use

To create a new project:

```sh
# make a directory for it
$ mkdir project && cd project

# run outset-lib, passing the project name
$ outset-lib project

# install dependencies, and start coding
$ npm i && npm run dev
```

## License