Skip to content

Commit 6772d93

Browse files
authored
Merge pull request #370 from weswalla/fix/weave-tool-base
Fix/weave tool base
2 parents 8741a67 + 3bf7701 commit 6772d93

File tree

211 files changed

+11168
-3663
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

211 files changed

+11168
-3663
lines changed

.github/nix.conf

Lines changed: 0 additions & 2 deletions
This file was deleted.

.github/workflows/dry-run.yml

Lines changed: 0 additions & 45 deletions
This file was deleted.

.github/workflows/release.yml

Lines changed: 0 additions & 74 deletions
This file was deleted.

.github/workflows/storybook.yml

Lines changed: 0 additions & 25 deletions
This file was deleted.

.github/workflows/unit-tests.yml

Lines changed: 0 additions & 31 deletions
This file was deleted.

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ electron/web
99

1010
zod-models/dist
1111

12+
web/dist.zip
1213
web/dist/fonts
1314
web/dist/images
1415
web/dist/*.js
@@ -32,4 +33,6 @@ my-proxy-cert.cert
3233
**/*.happ
3334

3435
**/.DS_Store
35-
.DS_Store
36+
.DS_Store
37+
.aider*
38+
.env

DEVELOPERS.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
21
## Developers
32

3+
### Managing Dependencies for Developing Acorn
4+
5+
There are several cargo and holochain dependencies you need to manage when you change any of the holochain aspects of Acorn:
6+
7+
- [`holochain-runner`](https://github.com/lightningrodlabs/holochain-runner)
8+
- a rust binary that bundles a preconfigured conductor to simplify the app packaging process.
9+
- [`electron-holochain`](https://github.com/lightningrodlabs/electron-holochain)
10+
- an electron template which includes `holochain-runner`, meant to reduce boilerplate around building desktop happs. All that's required are the UI and `.happ` files.
11+
- [`hdk_crud`](https://github.com/lightningrodlabs/hdk_crud)
12+
- a generic zome utility crate for defining entry types and automatically generating CRUD for each of them. Used by `acorn-happ`.
13+
- [`acorn-happ`](https://github.com/lightningrodlabs/acorn-happ)
14+
- all of the zome logic lives here. Uses `hdk_crud` to define all the Acorn entry types, like outcomes, edges, etc.
15+
16+
### Building the frontend
17+
18+
There are two build targets:
19+
20+
- desktop
21+
- Weave app
22+
423
### Run Locally and Develop on your Computer
524

625
_Prerequisites_
@@ -33,6 +52,7 @@ You can run the web process and the electron processes separately, instead of ru
3352
- `yarn run electron`
3453

3554
#### Multi-User Testing
55+
3656
run the following commands in separate terminal instances (must have a running instance of acorn for the first user, either by running `yarn run dev` or the below commands without the `2`):
3757

3858
- `yarn run web(2,3,4)`
@@ -51,37 +71,38 @@ The packaged executables can be found in `frontend/electron/out`.
5171
In order to get cross-platform builds, just tag your repository like `v1.0.0-alpha` and push the tag to Github. CI will automatically start running a build, under the "Release" action.
5272

5373
> Macos: You will need to have set the following environment variables as repository secrets:
74+
>
5475
> - APPLE_CERTIFICATE_BASE64
5576
> - APPLE_CERTIFICATE_PASS
5677
> - APPLE_DEV_IDENTITY
5778
> - APPLE_ID_EMAIL
5879
> - APPLE_ID_PASSWORD
5980
> - APPLE_TEAM_ID
60-
>
81+
>
6182
> The first two should be set as equivalents of `MACOS_CERTIFICATE` = `APPLE_CERTIFICATE_BASE64` and `MACOS_CERTIFICATE_PWD` = `APPLE_CERTIFICATE_PASS` as found in the following article, which also provides other instruction regarding this: https://localazy.com/blog/how-to-automatically-sign-macos-apps-using-github-actions
6283
63-
6484
### Versioning
6585

66-
Each version of the app will either change, or not change, the paths to the user data folders in use by the application.
86+
Each version of the app will either change, or not change, the paths to the user data folders in use by the application.
6787

6888
The user data will be located under `acorn` in the platform specific appData folder, as specified by `appData` here: https://www.electronjs.org/docs/latest/api/app#appgetpathname
6989

70-
It is then in a specific sub-folder that relates to one of two types of data:
90+
It is then in a specific sub-folder that relates to one of two types of data:
91+
7192
- source chain and DHT -> `databases-${INTEGRITY_VERSION_NUMBER}`
7293
- private keys -> `keystore-${KEYSTORE_VERSION_NUMBER}`
7394

7495
INTEGRITY_VERSION_NUMBER and KEYSTORE_VERSION_NUMBER are defined in `electron/src/holochain.ts` and can be modified as needed in order to jump to new versions of holochain, or a new app DNA.
7596

76-
You can tweak INTEGRITY_VERSION_NUMBER and KEYSTORE_VERSION_NUMBER independently.
97+
You can tweak INTEGRITY_VERSION_NUMBER and KEYSTORE_VERSION_NUMBER independently.
7798

7899
INTEGRITY_VERSION_NUMBER should be incremented when a new DNA is in use, or when a new version of holochain which is not backwards compatible with prior versions is bumped to. In the case of new happ files being used, this occurs when the version number of the happ release in [./scripts/download-happs.sh](./scripts/download-happs.sh) changes. It will cause users to have to go through the migration process.
79100

80101
KEYSTORE_VERSION_NUMBER should be incremented if the version of lair-keystore changes, and has a new key format. Or if you otherwise want users to have to switch and generate new keys.
81102

82103
## Happ Code
83104

84-
The happ code has been separated into its own repository with its own release process. This has been done even though developing new features can sometimes involve the modification of that code, as well as the frontend and desktop wrapper code.
105+
The happ code has been separated into its own repository with its own release process. This has been done even though developing new features can sometimes involve the modification of that code, as well as the frontend and desktop wrapper code.
85106

86107
The repo is here: https://github.com/lightningrodlabs/acorn-happ.
87108

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
# Acorn
22

3-
Built with [**Holochain**](https://www.holochain.org/), Acorn ([acorn.software](https://acorn.software)) is an open-source, peer-to-peer project management application. It is designed and built as a scrum-alternative, [Agile Development Pattern](https://en.wikipedia.org/wiki/Agile_software_development) for distributed software development teams.
3+
Built with [**Holochain**](https://www.holochain.org/), Acorn ([acorn.software](https://acorn.software)) is an open-source, peer-to-peer project management application. It is designed and built as a scrum-alternative, [Agile Development Pattern](https://en.wikipedia.org/wiki/Agile_software_development) for distributed software development teams.
44

55
Acorn is currently in **Alpha** testing phase.
66

77
## Things you can do
88

9-
- [**Download & install the latest Acorn release**](https://github.com/lightningrodlabs/acorn/releases/tag/v9.9.0).
9+
- [**Download & install the latest Acorn release**](https://github.com/lightningrodlabs/acorn/releases/tag/v11.1.0).
1010

1111
- Check out the [Acorn Knowledge Base](https://docs.acorn.software) to learn more about Acorn, its methodology and features.
1212

1313
- Join the [Acorn alpha testing list](https://forms.gle/Ani18rJhDuAGv9LQ8) to get the latest news about Acorn.
1414

1515
- Are you a developer? [Read on](./DEVELOPERS.md).
1616

17-
1817
![A Sample of Acorn App Design showing Expanded View of an Outcome with details such as Outcome Statement, Achievement Status, GitHub Link, Tags, Assignees, Time, Description, and Action Buttons.](https://github.com/lightningrodlabs/acorn/blob/main/acorn-design-sample-june2022.png)
1918

20-
21-
© 2020-2023 Harris-Braun Enterprises, LLC, operating as [Lightningrod Labs](https://lightningrodlabs.org). Licensed under the [Cryptographic Autonomy License v1.0](https://opensource.org/licenses/CAL-1.0).
19+
© 2020-2024 Harris-Braun Enterprises, LLC, operating as [Lightningrod Labs](https://lightningrodlabs.org). Licensed under the [Cryptographic Autonomy License v1.0](https://opensource.org/licenses/CAL-1.0).

electron/.gitignore

Lines changed: 0 additions & 91 deletions
This file was deleted.

0 commit comments

Comments
 (0)