Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/librariesio/yarn-parser

:cat2: Tiny web service for parsing yarn.lock files
https://github.com/librariesio/yarn-parser

dependencies librariesio parser yarn

Last synced: 2 months ago
JSON representation

:cat2: Tiny web service for parsing yarn.lock files

Awesome Lists containing this project

README

        

# Yarn parser

A tiny node.js web service for parsing dependency information from `yarn.lock` files for [Libraries.io](https://libraries.io).

## Docker

First, install Docker. If you run macOS or Windows, Docker for Mac/Windows makes this really easy.

If you have Windows Home Edition, you'll need to download and run Docker Toolbox.
Then, run:

``` shell
docker pull librariesio/yarn-parser
docker run -it -e PORT=5000 -p 5000:5000 librariesio/yarn-parser
```

yarn-parser will be running on http://localhost:5000.

Note: You can add PORT to a .env file instead of supplying them directly on the command-line.

## Development

Source hosted at [GitHub](http://github.com/librariesio/yarn-parser).
Report issues/feature requests on [GitHub Issues](http://github.com/librariesio/yarn-parser/issues). Follow us on Twitter [@librariesio](https://twitter.com/librariesio). We also hangout on [Slack](http://slack.libraries.io).

To run locally:

```
docker run -it -e PORT=5000 -p 5000:5000 $(docker build -q .)
```

### Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Add documentation if necessary.
* Commit, do not change procfile, version, or history.
* Send a pull request. Bonus points for topic branches.

## Copyright

Copyright (c) 2017 Andrew Nesbitt. See [LICENSE](https://github.com/librariesio/yarn-parser/blob/master/LICENSE) for details.