dependagraph v0.1.0

Getting Started

Prerequisites

At this time, Dependagraph only supports projects using npm, support for projects using others packages managers is coming soon. Please see the roadmap for more information.

• npm

  npm install npm@latest -g

• Node.js v14.17.5 or later

Installation

Install the package globally using npm

npm install dependagraph@latest -g

OR

Install it locally to access the API for use in your own project

npm install dependagraph@latest --save

Usage

1. Put yourself at the root of your project's directory

   cd /your/project/dir

2. Launch dependagraph

   dependagraph

At this point, Dependagraph will parse your package-lock.json file to generates nodes and edges to be used by the vis.js library. Once this is done, a new HTML document should pop inside a dependagraph directory at the root of your project.

Roadmap

• Full support for yarn
• Writing an actual UI
  • Using Vue.js and TailwindCSS
  • Getting more information on a clicked dependency on the graph
  • Checking for more recent dependencies versions
  • Color-coded graph nodes
  • Real-time filtering
• Supporting other languages

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Acknowledgments

• Jérémy Castellano
• Vis.js community
• All contributors