https://github.com/rakannimer/rn-js-library

A boilerplate repo to clone when starting a new JS library.
https://github.com/rakannimer/rn-js-library

Last synced: 12 days ago
JSON representation

A boilerplate repo to clone when starting a new JS library.

• Host: GitHub
• URL: https://github.com/rakannimer/rn-js-library
• Owner: rakannimer
• Created: 2017-12-23T07:57:55.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-25T08:49:26.000Z (about 7 years ago)
• Last Synced: 2024-12-16T22:13:42.122Z (2 months ago)
• Language: JavaScript
• Size: 62.5 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Boilerplate project for building a JS library.

  

### The problem.

When developing a JS library, it takes a lot of time to configure it right.

This is a boilerplate I use for quickly getting started with a (relatively) clean project.

### This solution.

**Uses** : 

  - [parcel](https://github.com/parcel-bundler/parcel) for running the demo.

  - [microbundle](https://github.com/developit/microbundle) for building the library and sourcemaps.

  - [jest](https://github.com/facebook/jest/) for testing.

  - [eslint](https://eslint.org/) with [standard](https://standardjs.com/) for code linting.

  - [prettier](https://github.com/prettier/prettier) for code formatting.

### Installation

```bash

  git clone https://github.com/rakannimer/rn-js-library MY_LIBRARY_NAME

  cd MY_LIBRARY_NAME && rm -rf ./.git

  yarn install

```

Ready to go. 👍

### Usage

Comes with the following scripts : 

1. Run demo with live reload.

```bash

  yarn demo 

```

2. Build.

```bash

  yarn build

```

3. Lint.

```bash

  yarn lint

```

4. Run Tests

```bash

  yarn test

```

5. Precommit test run

Before committing all staged js(on) code is linted, prettified and tested.