veilid-dot-com/pages/docs/code-repositories.md
Alice Rhodes 363e020ef6 Improving documentation availablility
- I put the slides in more obvious places
- I took the /defcon pages off the main menu; they're still there though
2023-08-20 06:37:37 -04:00

36 lines
1.3 KiB
Markdown

---
title: Code Repositories
description: The code base for the different parts and tools of Veilid
weight: 3
layout: subpage
---
### Veilid Framework
#### Getting Started
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.
#### 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
### Packages
If you want to install `veilid-server` and `veilid-cli` from package repositories,
please refer to our [instructions](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md).
### VeilidChat
The code for VeilidChat will be available at https://gitlab.com/veilid/veilidchat once we're recovered from DefCon.