Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving Developer Onboarding Documentation #883

Merged
merged 4 commits into from
Nov 2, 2023
Merged

Improving Developer Onboarding Documentation #883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8b1b88f
add comments to explain tutorials more
kernelkind Nov 2, 2023
b6d4f4a
modify target directory command
kernelkind Nov 2, 2023
5583d67
add webassembly target command
kernelkind Nov 2, 2023
721b01a
change working app microblogging -> email. Has verbose readme
kernelkind Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions apps/freenet-email-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,30 @@ local node, which simulates a node on the network.
```bash
curl https://sh.rustup.rs -sSf | sh
```
- (Ubuntu)
```bash
sudo apt-get update
sudo apt-get install libssl-dev libclang-dev pkg-config
```
- Install the Freeenet development tool (fdev) and a working Freenet kernel that can be used for local development. Use cargo to install it:
```bash
cargo install freenet
cargo install fdev
```
- Install Dioxus-CLI, a GUI library for rust
```bash
cargo install dioxus-cli
```
- Add WebAssembly target
```bash
rustup target add wasm32-unknown-unknown
```
- Initializing & Fetching Submodules
```bash
git submodule update --init --recursive
```
### Note about MacOS
Email account creation currently does not work on MacOS

## Prepare the Freenet email contracts and delegates

Expand All @@ -39,6 +58,11 @@ This delegate is located inside the modules folder of freenet-core:
- `Makefile` <-- this file contains the build instructions for the delegate
- ...

Add the target directory for the project. This should be an absolute file path to freenet-core/target.
```bash
export CARGO_TARGET_DIR="... freenet-core/target"
```

To build the delegate, go to the `identity-management` folder and run the following command:

```bash
Expand Down
12 changes: 10 additions & 2 deletions docs/src/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

This tutorial will show you how to build decentralized software on Freenet. For a similar working and up to date example check the `freenet-microblogging` app (located in under the `apps/freenet-microblogging` directory in the `freenet-core` repository).
This tutorial will show you how to build decentralized software on Freenet. For a similar working and up to date example check the `freenet-email` app (located in under the `apps/freenet-email-app` directory in the `freenet-core` repository).

<!-- toc -->

Expand All @@ -15,18 +15,26 @@ Mac (for Windows see [here](https://rustup.rs)):
curl https://sh.rustup.rs -sSf | sh
```

#### Note for MacOS install
Do not have the `brew` version of rust installed as it will cause compications with `fdev`.

### Freenet development tool (fdev)

Once you have a working installation of Cargo you can install the Freenet dev
tools:

```bash
cargo install freenet
cargo install freenet fdev
```

This command will install `fdev` (Freenet development tool) and a working Freenet kernel that can
be used for local development.

### Add WebAssembly target
```bash
rustup target add wasm32-unknown-unknown
```

### Node.js and TypeScript

To build user interfaces in JavaScript or TypeScript, you need to have Node.js
Expand Down
Loading