Spaces:
Running
Running
File size: 1,463 Bytes
c069d9e a56f05f c069d9e a56f05f c069d9e 20d727f c069d9e 20d727f c069d9e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# Contributing
The LynxKite 2000:MM repository lives at
[https://github.com/lynxkite/lynxkite-2000](https://github.com/lynxkite/lynxkite-2000). Bug reports, feature requests,
and pull requests are welcome!
## Project structure
- `lynxkite-core`: Core types and utilities. Depend on this lightweight package if you are writing LynxKite plugins.
- `lynxkite-app`: The LynxKite web application. Install some plugins then run this to use LynxKite.
- `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
- `lynxkite-pillow`: A simple example plugin.
- `lynxkite-lynxscribe`: A plugin for building and running LynxScribe applications.
- `lynxkite-bio`: Bioinformatics additions for LynxKite Graph Analytics.
- `docs`: User-facing documentation. It's shared between all packages.
## Development setup
Install everything like this:
```bash
uv venv
source .venv/bin/activate
uvx pre-commit install
uv sync
```
This also builds the frontend, hopefully very quickly. To run it:
```bash
cd examples
lynxkite
```
If you also want to make changes to the frontend with hot reloading:
```bash
cd lynxkite-app/web
npm run dev
```
## Executing tests
```bash
pytest # Runs all backend unit tests.
pytest lynxkite-core # Runs tests for one package.
cd lynxkite-app/web && npm run test # Runs frontend tests.
```
## Documentation
To work on the documentation:
```bash
mkdocs serve
```
|