Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/henriquecarv/bundle-size

Find the cost of adding a npm package to your bundle
https://github.com/henriquecarv/bundle-size

bundlephobia henriquecarv koa koa-router nextjs

Last synced: 3 months ago
JSON representation

Find the cost of adding a npm package to your bundle

Host: GitHub
URL: https://github.com/henriquecarv/bundle-size
Owner: henriquecarv
License: mit
Created: 2020-05-31T07:00:02.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-01-06T07:55:58.000Z (about 2 years ago)
Last Synced: 2023-03-02T10:45:54.501Z (almost 2 years ago)
Topics: bundlephobia, henriquecarv, koa, koa-router, nextjs
Language: TypeScript
Homepage:
Size: 1.41 MB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 70
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # bundle-size

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e48a66aed7824ca5a8cd63fdfb3ccb6f)](https://www.codacy.com/manual/henriquecarv/bundle-size?utm_source=github.com&utm_medium=referral&utm_content=henriquecarv/bundle-size&utm_campaign=Badge_Grade)

[![CircleCI](https://img.shields.io/circleci/build/github/henriquecarv/bundle-size?token=21f1fb4f1ba927d177a254bf8030295e7ffa3bae)](https://circleci.com/gh/henriquecarv/bundle-size)

[![LICENSE](https://img.shields.io/github/license/henriquecarv/bundle-size.svg)](./LICENSE)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=henriquecarv/bundle-size)](https://dependabot.com)

## System Requirements

- [NodeJS](https://nodejs.org/en/) (version >= 12).

- [Docker](https://docs.docker.com/engine/install/) - **if running with docker** (version >= 19)

- [Docker compose](https://docs.docker.com/compose/install/) **if running with docker** (version >= 1.25.5)

## Setup

- `yarn install`

- `yarn env`

## Running in Production mode

- `yarn build`

- `yarn start`

- The application will run on 

## Running with docker

- `yarn docker:start`

## Running in development mode

- `yarn dev`

## Testing

- `yarn test`

### Todo

- [ ] Clean installs temporary folder after package versions sizes retrieval

- [ ] Add more automated tests and test coverage report

- [ ] Include search field in the Package page to continue searching for other packages from there

- [ ] Add database instance to be able to reuse the already searched and built package versions

### License

Copylefted (c) 2020 [Henrique Carvalho da Cruz][1] Licensed under the [MIT license][2].

[1]: https://henriquecarv.com

[2]: ./LICENSE