https://github.com/micrub/babel-lib-kit-example

https://github.com/micrub/babel-lib-kit-example

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/micrub/babel-lib-kit-example
• Owner: micrub
• Created: 2017-08-04T10:42:01.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2017-08-04T10:43:38.000Z (over 7 years ago)
• Last Synced: 2024-11-08T08:46:43.424Z (about 2 months ago)
• Language: JavaScript
• Size: 95.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Babel compiler based Javascript application starter kit, with build process for Node.js and browser environments.

![Travis `develop` branch build](https://travis-ci.org/micrub/babel-lib-kit.svg?branch=develop "Travis `develop` branch build")

Starter kit using based on `yarn`, `babel-presets-env`, `webpack` and `browserify`.

# Getting started

1. [ Install `yarn` ](https://yarnpkg.com/en/docs/install)

1. Run `yarn` in repository directory.

2. Edit `package.json` default values like : name and version.

2. Change `README.md`.

3. Add and edit content in `src/` and `resources/` directories.

4. Write tests in `test/` directory.

## Run tests

`npm test`

## Creating module build

1. Inspect name and version in `package.json`, edit if necessary.

2. Run `npm run build`

3. Output will be placed in `dist/` directory, which can be published as NPM module.

# Build options

Build can be done using `browserify` or `webpack`:

## Webpack

```

npm run build

```

## Browserify

```

npm run browserify-build

```

**TODO** Tune to be equal to webpack build process.