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

dev machine setup clarifications #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

dev machine setup clarifications #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35fac4a
reiterate setup steps needed on dev machine
dkackman Oct 10, 2024
5bcf3f7
clarify setup steps and some additional details
dkackman Oct 10, 2024
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
16 changes: 14 additions & 2 deletions docs/Setup/dev-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Before you begin deploying your project to the DIG Network, ensure that you have

Once your DIG Node is fully configured, you're ready to proceed with the following steps in the project directory where your dApp or project is located.

3. **Optional**: If you are publishing a dApp from a machine other than the one that is running your DIG Node, execute these setup steps on that machine. Use the same credentials and seed as you did for your DIG Node.

```bash
npm install @dignetwork/dig-chia-cli@alpha -g
dignode remote set peer <dig node public ip address> --username <generated username> --password <generated password>
dignode remote sync seed
```

---

#### Step 1: Prepare Your Project
Expand All @@ -30,10 +38,12 @@ Once your DIG Node is fully configured, you're ready to proceed with the followi

2. **Build Your Project:**
- Compile your project, directing the output to the `./dist` folder (or any build folder of your choice). By default, the DIG CLI looks for the `./dist` folder:

```bash
npm run build
npm run build # example for a nodejs dApp
```
- Ensure that your compiled files are present in the `./dist` folder before proceeding.

- Ensure that your compiled files are present in the `./dist` as that is where they will be added to the network from.

---

Expand All @@ -52,6 +62,7 @@ Once your DIG Node is fully configured, you're ready to proceed with the followi
#### Step 3: Commit Your Build to the Data Store

1. **Commit the `dist` Folder:**
- Ensure that your compiled app and/or content files are present in the `./dist` folder before proceeding.
- Use the following command to commit your `dist` folder (or your chosen build directory) to the DIG data store:
```bash
dignode commit
Expand All @@ -67,6 +78,7 @@ Once your DIG Node is fully configured, you're ready to proceed with the followi
```bash
dignode push
```
- Enter the IP address of your dig node when prompted for a peer address.
- Ensure your DIG Node is set up and running according to the previous setup guide. This command verifies file integrity and permissions during the upload process.

---
Expand Down