2023-08-15 15:25:21 -04:00
|
|
|
---
|
2023-08-23 12:24:30 -04:00
|
|
|
title: Download
|
2023-08-15 15:25:21 -04:00
|
|
|
description: The code base for the different parts and tools of Veilid
|
2023-08-23 12:24:30 -04:00
|
|
|
menu:
|
|
|
|
|
main:
|
|
|
|
|
weight: 2
|
|
|
|
|
layout: index
|
2023-08-15 15:25:21 -04:00
|
|
|
---
|
|
|
|
|
|
2023-08-23 12:24:30 -04:00
|
|
|
### Getting Started
|
2023-08-15 15:25:21 -04:00
|
|
|
|
|
|
|
|
Please recursively check out the project using this command
|
|
|
|
|
|
|
|
|
|
`git clone --recurse-submodules git@gitlab.com:veilid/veilid.git`
|
|
|
|
|
|
|
|
|
|
Then read the [development](https://gitlab.com/veilid/veilid/-/blob/main/DEVELOPMENT.md) guide to get started.
|
|
|
|
|
|
2023-08-23 12:24:30 -04:00
|
|
|
### About the Code Repo
|
2023-08-15 15:25:21 -04:00
|
|
|
|
|
|
|
|
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
|
