mirror of
https://gitlab.com/veilid/veilid-dot-com.git
synced 2025-03-12 18:36:42 -04:00
34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
---
|
|
title: Code Repositories
|
|
description: The code base for the different parts and tools of Veilid Framework
|
|
section: "Contribute"
|
|
weight: 2
|
|
---
|
|
|
|
### Code of Conduct
|
|
|
|
Please take a moment to review our [Code of Conduct](/code-of-conduct)
|
|
|
|
### Running a Node
|
|
|
|
To install the Veilid node software, please follow the instructions available in the [repository](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md).
|
|
|
|
### Starting Development
|
|
|
|
Please recursively check out the project using this command
|
|
|
|
`git clone git@gitlab.com:veilid/veilid.git`
|
|
|
|
Then read the [development](https://gitlab.com/veilid/veilid/-/blob/main/DEVELOPMENT.md) guide to get started.
|
|
|
|
There is also a [Veilid Book](https://veilid.gitlab.io/developer-book/).
|
|
|
|
### About the Code Repo
|
|
|
|
The main repository is located at https://gitlab.com/veilid/veilid and includes several components
|
|
- `veilid-core` - the main Veilid crate: https://crates.io/crates/veilid-core
|
|
- `veilid-tools` - misc functions for veilid and friends: https://crates.io/crates/veilid-tools
|
|
- `veilid-wasm` - Veilid bindings for webassembly: https://crates.io/crates/veilid-wasm
|
|
- `veilid-flutter` - Veilid bindings for Flutter/Dart. Comes with an example program: https://crates.io/crates/veilid-flutter
|
|
- Also `veilid-server` and `veilid-cli` source are also in this repo for building headless nodes
|