Skip to content

librariesio/mix-deps-json

Repository files navigation

mix-deps-json

Build Status Inline docs license Docker Automated build

This is a minimal elixir proxy that accepts a mix.exs file as a POST body, and spits out the project dependencies as JSON for Libraries.io.

Processed requests return a status code of 200 and JSON body, failed requests will return 422 and ":(" as the body.

Docker

You can use Docker to run mix-deps-json

First, install Docker. If you've got 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:

docker run -t -e PORT=5000 -p 5000:5000 mix-deps-json

mix-deps-json 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. Report issues/feature requests on GitHub Issues. Follow us on Twitter @librariesio. We also hangout on Gitter.

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) 2016 Andrew Nesbitt. See LICENSE for details.