Spaces:
Running
Running
Merge pull request #11 from lynxkite/darabos-contributing
Browse files- README.md +6 -46
- docs/contributing.md +54 -0
- lynxkite-app/web/src/index.css +4 -0
- lynxkite-app/web/src/workspace/nodes/Group.tsx +1 -2
- mkdocs.yml +3 -2
README.md
CHANGED
|
@@ -15,57 +15,17 @@ The two tools offer similar functionality, but are not compatible.
|
|
| 15 |
This version runs on GPU clusters instead of Hadoop clusters.
|
| 16 |
It targets CUDA instead of Apache Spark. It is much more extensible.
|
| 17 |
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
## Structure
|
| 21 |
-
|
| 22 |
-
- `lynxkite-core`: Core types and utilities. Depend on this lightweight package if you are writing LynxKite plugins.
|
| 23 |
-
- `lynxkite-app`: The LynxKite web application. Install some plugins then run this to use LynxKite.
|
| 24 |
-
- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
|
| 25 |
-
- `lynxkite-pillow`: A simple example plugin.
|
| 26 |
-
- `docs`: User-facing documentation. It's shared between all packages.
|
| 27 |
-
|
| 28 |
-
## Development
|
| 29 |
-
|
| 30 |
-
Install everything like this:
|
| 31 |
-
|
| 32 |
-
```bash
|
| 33 |
-
uv venv
|
| 34 |
-
source .venv/bin/activate
|
| 35 |
-
uvx pre-commit install
|
| 36 |
-
# The [dev] tag is only needed if you intend on running tests
|
| 37 |
-
uv pip install -e lynxkite-core/[dev] -e lynxkite-app/[dev] -e lynxkite-graph-analytics/[dev] -e lynxkite-pillow-example/
|
| 38 |
-
```
|
| 39 |
-
|
| 40 |
-
This also builds the frontend, hopefully very quickly. To run it:
|
| 41 |
-
|
| 42 |
-
```bash
|
| 43 |
-
cd examples && lynxkite
|
| 44 |
-
```
|
| 45 |
-
|
| 46 |
-
If you also want to make changes to the frontend with hot reloading:
|
| 47 |
-
|
| 48 |
-
```bash
|
| 49 |
-
cd lynxkite-app/web
|
| 50 |
-
npm run dev
|
| 51 |
-
```
|
| 52 |
-
|
| 53 |
-
## Executing tests
|
| 54 |
-
|
| 55 |
-
Run all tests with a single command, or look inside to see how to run them individually:
|
| 56 |
|
| 57 |
```bash
|
| 58 |
-
|
| 59 |
```
|
| 60 |
|
| 61 |
-
##
|
| 62 |
-
|
| 63 |
-
To work on the documentation:
|
| 64 |
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
```
|
| 69 |
|
| 70 |
## License
|
| 71 |
|
|
|
|
| 15 |
This version runs on GPU clusters instead of Hadoop clusters.
|
| 16 |
It targets CUDA instead of Apache Spark. It is much more extensible.
|
| 17 |
|
| 18 |
+
## Installation
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|
| 20 |
```bash
|
| 21 |
+
pip install lynxkite lynxkite-graph-analytics
|
| 22 |
```
|
| 23 |
|
| 24 |
+
## Getting started
|
|
|
|
|
|
|
| 25 |
|
| 26 |
+
- [Online demo](https://lynx-analytics-lynxkite.hf.space/)
|
| 27 |
+
- [Quickstart](https://lynxkite.github.io/lynxkite-2000/guides/quickstart/)
|
| 28 |
+
- [Contributing](https://lynxkite.github.io/lynxkite-2000/contributing/)
|
|
|
|
| 29 |
|
| 30 |
## License
|
| 31 |
|
docs/contributing.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing
|
| 2 |
+
|
| 3 |
+
The LynxKite 2000:MM repository lives at [https://github.com/lynxkite/lynxkite-2000](https://github.com/lynxkite/lynxkite-2000).
|
| 4 |
+
Bug reports, feature requests, and pull requests are welcome!
|
| 5 |
+
|
| 6 |
+
## Project structure
|
| 7 |
+
|
| 8 |
+
- `lynxkite-core`: Core types and utilities. Depend on this lightweight package if you are writing LynxKite plugins.
|
| 9 |
+
- `lynxkite-app`: The LynxKite web application. Install some plugins then run this to use LynxKite.
|
| 10 |
+
- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
|
| 11 |
+
- `lynxkite-pillow`: A simple example plugin.
|
| 12 |
+
- `docs`: User-facing documentation. It's shared between all packages.
|
| 13 |
+
|
| 14 |
+
## Development setup
|
| 15 |
+
|
| 16 |
+
Install everything like this:
|
| 17 |
+
|
| 18 |
+
```bash
|
| 19 |
+
uv venv
|
| 20 |
+
source .venv/bin/activate
|
| 21 |
+
uvx pre-commit install
|
| 22 |
+
uv pip install -e 'lynxkite-core/[dev]' -e 'lynxkite-app/[dev]' -e 'lynxkite-graph-analytics/[dev]' -e lynxkite-pillow-example/
|
| 23 |
+
```
|
| 24 |
+
|
| 25 |
+
This also builds the frontend, hopefully very quickly. To run it:
|
| 26 |
+
|
| 27 |
+
```bash
|
| 28 |
+
cd examples
|
| 29 |
+
lynxkite
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
If you also want to make changes to the frontend with hot reloading:
|
| 33 |
+
|
| 34 |
+
```bash
|
| 35 |
+
cd lynxkite-app/web
|
| 36 |
+
npm run dev
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
## Executing tests
|
| 40 |
+
|
| 41 |
+
Run all tests with a single command, or look inside to see how to run them individually:
|
| 42 |
+
|
| 43 |
+
```bash
|
| 44 |
+
./test.sh
|
| 45 |
+
```
|
| 46 |
+
|
| 47 |
+
## Documentation
|
| 48 |
+
|
| 49 |
+
To work on the documentation:
|
| 50 |
+
|
| 51 |
+
```bash
|
| 52 |
+
uv pip install mkdocs-material mkdocstrings[python]
|
| 53 |
+
mkdocs serve
|
| 54 |
+
```
|
lynxkite-app/web/src/index.css
CHANGED
|
@@ -110,6 +110,10 @@ body {
|
|
| 110 |
padding: 10px 20px;
|
| 111 |
}
|
| 112 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 113 |
.node-group-color-picker-icon {
|
| 114 |
font-size: 30px;
|
| 115 |
opacity: 0.1;
|
|
|
|
| 110 |
padding: 10px 20px;
|
| 111 |
}
|
| 112 |
|
| 113 |
+
.node-group.in-group {
|
| 114 |
+
opacity: 0.5;
|
| 115 |
+
}
|
| 116 |
+
|
| 117 |
.node-group-color-picker-icon {
|
| 118 |
font-size: 30px;
|
| 119 |
opacity: 0.1;
|
lynxkite-app/web/src/workspace/nodes/Group.tsx
CHANGED
|
@@ -24,12 +24,11 @@ export default function Group(props: any) {
|
|
| 24 |
const currentColor = props.data?.params?.color || "gray";
|
| 25 |
return (
|
| 26 |
<div
|
| 27 |
-
className=
|
| 28 |
style={{
|
| 29 |
width: props.width,
|
| 30 |
height: props.height,
|
| 31 |
backgroundColor: COLORS[currentColor],
|
| 32 |
-
opacity: 0.9,
|
| 33 |
}}
|
| 34 |
>
|
| 35 |
<button
|
|
|
|
| 24 |
const currentColor = props.data?.params?.color || "gray";
|
| 25 |
return (
|
| 26 |
<div
|
| 27 |
+
className={`node-group ${props.parentId ? "in-group" : ""}`}
|
| 28 |
style={{
|
| 29 |
width: props.width,
|
| 30 |
height: props.height,
|
| 31 |
backgroundColor: COLORS[currentColor],
|
|
|
|
| 32 |
}}
|
| 33 |
>
|
| 34 |
<button
|
mkdocs.yml
CHANGED
|
@@ -4,9 +4,10 @@ repo_name: lynxkite/lynxkite-2000
|
|
| 4 |
watch: [mkdocs.yml, README.md, lynxkite-core, lynxkite-graph-analytics, lynxkite-app]
|
| 5 |
|
| 6 |
nav:
|
| 7 |
-
-
|
| 8 |
- Overview: index.md
|
| 9 |
-
-
|
|
|
|
| 10 |
- Guides:
|
| 11 |
- guides/quickstart.md
|
| 12 |
- guides/analytics.md
|
|
|
|
| 4 |
watch: [mkdocs.yml, README.md, lynxkite-core, lynxkite-graph-analytics, lynxkite-app]
|
| 5 |
|
| 6 |
nav:
|
| 7 |
+
- About LynxKite:
|
| 8 |
- Overview: index.md
|
| 9 |
+
- contributing.md
|
| 10 |
+
- license.md
|
| 11 |
- Guides:
|
| 12 |
- guides/quickstart.md
|
| 13 |
- guides/analytics.md
|