2021-09-04 03:59:14 +03:00
|
|
|
# graph-drill
|
2021-09-04 01:34:55 +03:00
|
|
|
|
2021-09-04 03:59:14 +03:00
|
|
|
This is a rapid prototype of a hierarchical graph viewer. Each node is expected to be assigned a community
|
|
|
|
using a hierarchical technique such as Louvain or Leiden. The communities will then be color-coded, and zooming
|
|
|
|
will drill down into the visible/selected communities.
|
2021-09-04 01:34:55 +03:00
|
|
|
|
2021-09-04 03:59:14 +03:00
|
|
|
# Getting started
|
2021-09-04 01:34:55 +03:00
|
|
|
|
2021-09-04 03:59:14 +03:00
|
|
|
This is a typical node/React project. Here is what you'll need to get running:
|
|
|
|
|
|
|
|
1. Install [node.js](https://nodejs.org/en/download/) for your platform
|
|
|
|
2. Install [yarn](https://classic.yarnpkg.com/en/docs/install)
|
|
|
|
|
|
|
|
After those dependencies are installed, from a command line:
|
|
|
|
|
|
|
|
1. `yarn install` - will get app dependencies downloaded and installed (see dependencies section below)
|
|
|
|
2. `yarn start` - will run the dev server and launch the app in your browser, usually at http://localhost:3000
|
|
|
|
|
|
|
|
## Available Scripts
|
|
|
|
|
|
|
|
In the project directory, you can run:
|
|
|
|
|
|
|
|
### `yarn start`
|
|
|
|
|
|
|
|
Runs the app locally. Open [http://localhost:8080](http://localhost:8080) to view it in the browser.
|
|
|
|
|
|
|
|
### `yarn bundle`
|
|
|
|
|
|
|
|
Builds the app for production to the `build` folder.
|
2021-09-04 01:34:55 +03:00
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
2021-09-04 03:59:14 +03:00
|
|
|
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
2021-09-04 01:34:55 +03:00
|
|
|
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
|
|
|
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
|
|
|
|
|
|
|
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
|
|
|
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
|
|
|
provided by the bot. You will only need to do this once across all repos using our CLA.
|
|
|
|
|
|
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
|
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
|
|
|
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
|
|
|
|
|
|
|
## Trademarks
|
|
|
|
|
2021-09-04 03:59:14 +03:00
|
|
|
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
|
|
|
|
trademarks or logos is subject to and must follow
|
2021-09-04 01:34:55 +03:00
|
|
|
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
|
|
|
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
|
|
Any use of third-party trademarks or logos are subject to those third-party's policies.
|