Rollup Lib App Starter

This is a starter app template that can be used as a base for building new libraries. This template also has a example app in web folder.

Getting Started

To get started, clone the repository and install the dependencies:

        
            git clone https://github.com/your-username/rollup-lib-app-starter.git
            cd rollup-lib-app-starter
            yarn install
            yarn install:web
        
    

Available Commands

Build library

        yarn build
    

Build library in watch mode

        yarn dev
    

Installs the dependencies for the web example

        yarn install:web
    

Starts the Parcel development server for the web example

        yarn start:web
    

Run unit tests

        yarn test
    

Run linter

        yarn lint
    

Build with

• Build Tools: The project uses Rollup for building the library and Parcel for the web example.
• Testing: Unit tests are set up using Jest and @testing-library.
• Code Styling and Formatting: ESLint and Prettier are set up for code styling and formatting.
• DevContainer: A devcontainer is set up for consistent development environments.
• Git Hooks: Husky and lint-staged are used to enforce code styling and formatting on commit.

Folder Structure

• Library Development: The src directory is used for building the library, which can be published as a standalone package.
• Web Example: The web directory contains an example web application that demonstrates the usage of the library.

DevContainer

This project includes a devcontainer configuration for Visual Studio Code. To use the devcontainer, open the project in Visual Studio Code and click the "Reopen in Container" button when prompted.

Git Hooks

This project uses Husky and lint-staged to enforce code styling and formatting on commit. When you commit changes, the linter and Prettier will automatically run, and the commit will be rejected if there are any issues.