IntenseWebs/veilid
3
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-12-28 17:01:00 -06:00
Code Issues Packages Projects Releases Wiki Activity
09d8a7720e
veilid/DEVELOPMENT.md

247 lines
7.0 KiB
Markdown
Raw Normal View History

Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
# Veilid Development
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
## Introduction
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
This guide covers setting up environments for core, Flutter/Dart, and Python development. See the relevent sections.
## Obtaining the source code
```shell
no more submodules
2023-09-02 20:13:08 -05:00
git clone https://gitlab.com/veilid/veilid.git
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```
## Dependencies
### GNU/Linux
Development of Veilid on GNU/Linux requires a Debian variant such as Debian
itself, Ubuntu or Mint. Pull requests to support other distributions would be
welcome!
Running the setup script requires:
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
* Android SDK and NDK
* Rust
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
You may decide to use Android Studio [here](https://developer.android.com/studio)
to maintain your Android dependencies. If so, use the dependency manager
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
within your IDE. If you plan on using Flutter for Veilid development, the Android Studio
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
method is highly recommended as you may run into path problems with the 'flutter'
command line without it. If you do so, you may skip to
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
[Run Veilid setup script](#Run Veilid setup script).
* build-tools;33.0.1
* ndk;25.1.8937393
* cmake;3.22.1
* platform-tools
* platforms;android-33
#### Setup Dependencies using the CLI
You can automatically install the prerequisites using this script:
```shell
Update DEVELOPMENT.md to reflect new paths.
2023-08-18 08:19:07 -05:00
./dev-setup/install_linux_prerequisites.sh
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```
Otherwise, you may choose to use Android `sdkmanager`. Follow the installation
instructions for `sdkmanager`
[here](https://developer.android.com/studio/command-line/sdkmanager), then use
the command line to install the requisite package versions:
```shell
sdkmanager --install "platform-tools"
sdkmanager --install "platforms;android-33"
sdkmanager --install "build-tools;33.0.1"
sdkmanager --install "ndk;25.1.8937393"
sdkmanager --install "cmake;3.22.1"
```
Export environment variables and add the Android SDK platform-tools directory to
your path.
```shell
cat << EOF >> ~/.profile
export ANDROID_SDK_ROOT=<path to sdk>
export ANDROID_NDK_HOME=$ANDROID_SDK_ROOT/ndk/25.1.8937393
export PATH=\$PATH:$ANDROID_SDK_ROOT/platform-tools
EOF
```
#### Run Veilid setup script
Now you may run the Linux setup script to check your development environment and
pull the remaining Rust dependencies:
```shell
Update DEVELOPMENT.md to reflect new paths.
2023-08-18 08:19:07 -05:00
./dev-setup/setup_linux.sh
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```
#### Run the veilid-flutter setup script (optional)
If you are developing Flutter applications or the flutter-veilid portion, you should
install Android Studio, and run the flutter setup script:
```shell
cd veilid-flutter
./setup_flutter.sh
```
### macOS
Development of Veilid on MacOS is possible on both Intel and ARM hardware.
Development requires:
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
* Android Studio
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
* Xcode, preferably latest version
* Homebrew [here](https://brew.sh)
* Android SDK and NDK
* Rust
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
You will need to use Android Studio [here](https://developer.android.com/studio)
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
to maintain your Android dependencies. Use the SDK Manager in the IDE to install the following packages (use package details view to select version):
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
* Android SDK Build Tools (33.0.1)
* NDK (Side-by-side) (25.1.8937393)
* Cmake (3.22.1)
* Android SDK 33
* Android SDK Command Line Tools (latest) (7.0/latest)
#### Setup command line environment
Export environment variables and add the Android SDK platform-tools directory to
your path.
```shell
cat << EOF >> ~/.zshenv
export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk
export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk/25.1.8937393
export PATH=\$PATH:$HOME/Library/Android/sdk/platform-tools
EOF
```
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
#### Run Veilid setup script (macOS)
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
Now you may run the MacOS setup script to check your development environment and
pull the remaining Rust dependencies:
```shell
Update DEVELOPMENT.md to reflect new paths.
2023-08-18 08:19:07 -05:00
./dev-setup/setup_macos.sh
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
```
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
#### Run the veilid-flutter setup script (optional) (macOS)
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
If you are developing Flutter applications or the flutter-veilid portion, you should
install Android Studio, and run the flutter setup script:
```shell
cd veilid-flutter
./setup_flutter.sh
```
### Windows
Document a way to get Veilid from source on Windows This provides one method for getting the Veilid source code on Windows, and launching a node. It is mainly intended to confirm that https://gitlab.com/veilid/cursive-flexi-logger-view/-/merge_requests/1 addresses a build problem. It provides a "development" environment in the sense that one could, in theory, edit the .rs files in Notepad. It does not discuss whether there is any value in seeing the debug messages in a cmd.exe window, and does not document other deployment options that may be possible, such as a Windows service. The information could be revised later to be more maintainable, e.g., by avoiding the hardcoded protoc and capnp version numbers and removing the x86_64 assumption.
2023-09-03 02:44:25 -05:00
For a simple installation allowing Rust development, follow these steps:
Cleaned up .md files syntax Used the VScode markdownlint utility to make the syntax and formatting of multuple .md files so that they are more correct.
2023-09-12 08:43:09 -05:00
Install Git from <https://git-scm.com/download/win>
Document a way to get Veilid from source on Windows This provides one method for getting the Veilid source code on Windows, and launching a node. It is mainly intended to confirm that https://gitlab.com/veilid/cursive-flexi-logger-view/-/merge_requests/1 addresses a build problem. It provides a "development" environment in the sense that one could, in theory, edit the .rs files in Notepad. It does not discuss whether there is any value in seeing the debug messages in a cmd.exe window, and does not document other deployment options that may be possible, such as a Windows service. The information could be revised later to be more maintainable, e.g., by avoiding the hardcoded protoc and capnp version numbers and removing the x86_64 assumption.
2023-09-03 02:44:25 -05:00
Require Cap’n Proto 1.0.1 on Windows This changes the Windows instructions to specify capnproto-c++-win32-1.0.1. Previously, users may have been trying to use Veilid with 0.10.4, especially in the common case of using the winget package manager. Also, the suggested Protocol Buffers version is updated to 24.3, and a note is added about rustup behavior on Windows machines that have never previously been used for development.
2023-09-15 13:24:25 -05:00
Install Rust from <https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe> (this may prompt you to run the Visual Studio Installer, and reboot, before proceeding).
Document a way to get Veilid from source on Windows This provides one method for getting the Veilid source code on Windows, and launching a node. It is mainly intended to confirm that https://gitlab.com/veilid/cursive-flexi-logger-view/-/merge_requests/1 addresses a build problem. It provides a "development" environment in the sense that one could, in theory, edit the .rs files in Notepad. It does not discuss whether there is any value in seeing the debug messages in a cmd.exe window, and does not document other deployment options that may be possible, such as a Windows service. The information could be revised later to be more maintainable, e.g., by avoiding the hardcoded protoc and capnp version numbers and removing the x86_64 assumption.
2023-09-03 02:44:25 -05:00
Require Cap’n Proto 1.0.1 on Windows This changes the Windows instructions to specify capnproto-c++-win32-1.0.1. Previously, users may have been trying to use Veilid with 0.10.4, especially in the common case of using the winget package manager. Also, the suggested Protocol Buffers version is updated to 24.3, and a note is added about rustup behavior on Windows machines that have never previously been used for development.
2023-09-15 13:24:25 -05:00
Ensure that protoc.exe is in a directory in your path. For example, it can be obtained from <https://github.com/protocolbuffers/protobuf/releases/download/v24.3/protoc-24.3-win64.zip>
Document a way to get Veilid from source on Windows This provides one method for getting the Veilid source code on Windows, and launching a node. It is mainly intended to confirm that https://gitlab.com/veilid/cursive-flexi-logger-view/-/merge_requests/1 addresses a build problem. It provides a "development" environment in the sense that one could, in theory, edit the .rs files in Notepad. It does not discuss whether there is any value in seeing the debug messages in a cmd.exe window, and does not document other deployment options that may be possible, such as a Windows service. The information could be revised later to be more maintainable, e.g., by avoiding the hardcoded protoc and capnp version numbers and removing the x86_64 assumption.
2023-09-03 02:44:25 -05:00
Require Cap’n Proto 1.0.1 on Windows This changes the Windows instructions to specify capnproto-c++-win32-1.0.1. Previously, users may have been trying to use Veilid with 0.10.4, especially in the common case of using the winget package manager. Also, the suggested Protocol Buffers version is updated to 24.3, and a note is added about rustup behavior on Windows machines that have never previously been used for development.
2023-09-15 13:24:25 -05:00
Ensure that capnp.exe (for Cap’n Proto 1.0.1) is in a directory in your path. For example, it can be obtained from the <https://capnproto.org/capnproto-c++-win32-1.0.1.zip> distribution. Please note that the Windows Package Manager Community Repository (i.e., winget) as of 2023-09-15 has version 0.10.4, which is not sufficient.
Document a way to get Veilid from source on Windows This provides one method for getting the Veilid source code on Windows, and launching a node. It is mainly intended to confirm that https://gitlab.com/veilid/cursive-flexi-logger-view/-/merge_requests/1 addresses a build problem. It provides a "development" environment in the sense that one could, in theory, edit the .rs files in Notepad. It does not discuss whether there is any value in seeing the debug messages in a cmd.exe window, and does not document other deployment options that may be possible, such as a Windows service. The information could be revised later to be more maintainable, e.g., by avoiding the hardcoded protoc and capnp version numbers and removing the x86_64 assumption.
2023-09-03 02:44:25 -05:00
Start a Command Prompt window.
```shell
git clone https://gitlab.com/veilid/veilid.git
cd veilid
cargo build
cd target
cd debug
veilid-server.exe
```
This may result in a popup window from local security software, asking whether you wish to allow network access by veilid-server.exe.
To use the CLI, navigate to the above `debug` directory in another Command Prompt window (while veilid-server.exe is still running), and type:
```shell
veilid-cli.exe
```
Add docs and mod version bumping Added and modified documentation for the contribution process. Added the code of conduct file. Modified bump version's conf to auto create tags and commits.
2023-08-01 21:37:38 -05:00
## Running the Application(s)
### Veilid Server
In order to run the `veilid-server` locally:
```shell
cd ./veilid-server
cargo run
```
In order to see what options are available:
```shell
cargo run -- --help
```
#### Configuration
`veilid-server` has a wealth of configuration options. Further documentation on
the format of the `veilid-server.conf` file may be found [in the project /doc
directory](./doc/config/veilid-server-config.md).
When running `veilid-server` in a Unix-like environment, the application will
look for its config file under `/etc/veilid-server/`. If the config file is not
found in this location, `veilid-server` will follow the XDG user directory spec
and look in `~/.config/veilid-server`.
When running under Windows, the `veilid-server.conf` file may be created at
`C:\Users\<user>\AppData\Roaming\Veilid\Veilid\`, and when running under macOS,
at `/Users/<user>/Library/Application Support/org.Veilid.Veilid`.
### Veilid CLI
In order to connect to your local `veilid-server`:
```shell
cd ./veilid-cli
cargo run
```
Similar to `veilid-server`, you may see CLI options by typing:
```shell
cargo run -- --help
```
## Building the Application
### Linux Packages
Veilid server and cli can be built locally using the
[Earthly](https://earthly.dev/) framework. After [installing earthly on your
local machine](https://earthly.dev/get-earthly), you may use the `earthly` cli
to initiate a build:
```shell
earthly +package-linux
```
This will assemble all dependencies and build `.deb` packages for both amd64 and
arm64 platforms. Earthly, built on Docker, caches build layers, so after a
longer first build, subsequent builds should be much quicker.
During development, you may want to kick off specific build steps. To see a list
of the build steps configured, consult the `Earthfile`, or you may use the
`earthly` cli:
```shell
earthly ls
```
Reference in New Issue Copy Permalink