You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
echo '[How to verify the authenticity of your Firefly Desktop download](https://wiki.iota.org/shimmer/introduction/how_tos/verify_download/#verify-your-firefly-desktop-download)' >> CHANGELOG.md
247
+
echo '[How to verify the authenticity of your Firefly ${{ env.NETWORK }} Desktop download](https://wiki.iota.org/shimmer/introduction/how_tos/verify_download/#verify-your-firefly-desktop-download)' >> CHANGELOG.md
Copy file name to clipboardexpand all lines: docs/guides/developer-tips.md
+25-24
Original file line number
Diff line number
Diff line change
@@ -10,23 +10,24 @@ Welcome to the Firefly developer tips! Here you will find all sorts of helpful i
10
10
11
11
### Backend
12
12
13
-
It is likely that you **will NOT** have to re-compile the backend (NodeJS *or* Capacitor) bindings, unless you have either changed or modified specific "bridge" functions (like [this one](https://github.com/iotaledger/firefly/blob/develop/packages/shared/lib/typings/account.ts#L66)).
13
+
It is likely that you **will NOT** have to re-compile the backend (NodeJS _or_ Capacitor) bindings, unless you have either changed or modified specific "bridge" functions (like [this one](https://github.com/iotaledger/firefly/blob/develop/packages/shared/lib/typings/account.ts#L66)).
14
14
15
15
### Desktop
16
16
17
17
#### Svelte Components
18
18
19
19
If simply making changes to Svelte component files, it is not usually required to fully refresh the development instance (it is typically refreshed for you).
20
20
21
-
In some cases, the changes can cause unrecoverable errors unless you refresh via the developer console. This usually happens when changing imports or adding a new Svelte file.
21
+
In some cases, the changes can cause unrecoverable errors unless you refresh via the developer console. This usually happens when changing imports or adding a new Svelte file.
22
22
23
23
#### TypeScript Library
24
24
25
25
If making changes within the TypeScript library files, it is usually necessary to refresh the development instance via the console so load the changes.
26
26
27
27
If editing files that are imported within `packages/desktop`, then it will be necessary to fully rebuild and restart the development instance. In particular, the following files require rebuilding:
28
-
-`shared/lib/core/shell/*.ts`
29
-
-`shared/lib/core/validation/*.ts`
28
+
29
+
-`shared/lib/core/shell/*.ts`
30
+
-`shared/lib/core/validation/*.ts`
30
31
31
32
32
33
## Common Processes
@@ -35,29 +36,29 @@ If editing files that are imported within `packages/desktop`, then it will be ne
35
36
36
37
To add a new (SVG-based) icon for use in the application, simply create a new object entry [here](https://github.com/iotaledger/firefly/blob/develop/packages/shared/components/icon/icons.js#L1).
37
38
38
-
Most entries here simply include `width`, `height`, and `path` properties, however please be sure that whatever icon you are adding contains all of the necessary SVG data to be displayed correctly (e.g. `fillRule`s, `clipRule`s, `strokeWidth`).
39
+
Most entries here simply include `width`, `height`, and `path` properties, however please be sure that whatever icon you are adding contains all of the necessary SVG data to be displayed correctly (e.g. `fillRule`s, `clipRule`s, `strokeWidth`).
39
40
40
41
If the icon is still not displaying properly, it is likely that it was either exported incorrectly or can be flattened in the design software **before** being exported.
41
42
42
43
### Adding a setting
43
44
44
45
There are a few steps to add a settings component to the Settings menu in Firefly:
45
46
46
-
- Add your component to the correct folder under `packages/shared/routes/dashboard/settings/views`
47
-
- Add an `export` statement to the barrel import/export file in the directory of your new component
48
-
- Add your component to the `settings` of the file with the same name as the settings (e.g. `Advance.svelte` for the advanced setting)
49
-
- Add your route enum to the appropriate settings route in `packages/shared/lib/core/router/enums/routes.ts`
50
-
- Add the correct `title` and additional texts to the `view` property in `packages/shared/locales/en.json` for the translations.
51
-
- Add an appropriate icon to`packages/shared/lib/typings/icons.ts`
47
+
-Add your component to the correct folder under `packages/shared/routes/dashboard/settings/views`
48
+
-Add an `export` statement to the barrel import/export file in the directory of your new component
49
+
-Add your component to the `settings` of the file with the same name as the settings (e.g. `Advance.svelte` for the advanced setting)
50
+
-Add your route enum to the appropriate settings route in `packages/shared/lib/core/router/enums/routes.ts`
51
+
-Add the correct `title` and additional texts to the `view` property in `packages/shared/locales/en.json` for the translations.
52
+
-Add an appropriate icon to`packages/shared/lib/typings/icons.ts`
52
53
53
54
### Adding a Svelte page
54
55
55
56
There are a few steps besides just creating the component file before it can work in Firefly:
56
57
57
-
- Add an `export` statement to the barrel import/export file in the directory of your new component
58
-
- Add the correct route value to the appropriate `enum` in `packages/shared/lib/typings/routes.ts`
59
-
- Add the correct HTML (`Route` nested with `<Page>` element) in `packages/desktop/App.svelte`
60
-
- Change logic as needed in `routerNext` in `packages/shared/lib/router.ts`
58
+
-Add an `export` statement to the barrel import/export file in the directory of your new component
59
+
-Add the correct route value to the appropriate `enum` in `packages/shared/lib/typings/routes.ts`
60
+
-Add the correct HTML (`Route` nested with `<Page>` element) in `packages/desktop/App.svelte`
61
+
-Change logic as needed in `routerNext` in `packages/shared/lib/router.ts`
61
62
62
63
### Exposing an API endpoint
63
64
@@ -74,11 +75,11 @@ See its [README](https://github.com/iotaledger/wallet.rs#dependencies) for the r
74
75
75
76
Log files are often required to debug `wallet.rs` issues. They can be found in the following folders:
For developer/alpha/beta builds you have to look for `Electron`/`'Firefly Shimmer - Alpha'`/`'Firefly Shimmer - Beta'` respectively.
82
+
For developer/alpha/beta builds you have to look for `Electron`/`'Firefly - Alpha'`/`'Firefly - Beta'` respectively.
82
83
83
84
#### Desktop
84
85
@@ -107,14 +108,14 @@ Wallet.initLogger({
107
108
108
109
in `desktop/electron/preload.js` after `const Wallet = binding`. Debug logs will then be added to the `wallet.log` file in the same location where Firefly or the Electron / Capacitor development instance is installed.
109
110
110
-
## Resetting Firefly
111
+
## Resetting Firefly
111
112
112
113
### Desktop
113
114
114
115
If you want to reset Firefly your profiles are stored in the following places on the different OS'es for the official release:
Copy file name to clipboardexpand all lines: docs/guides/git/branches.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@ icon: git-branch
4
4
5
5
# Branches
6
6
7
-
Branch names __must__ follow a certain structure, which is `branch-prefix/branch-name`. The `branch-prefix` corresponds to one of the conventional commit types defined above and the branch name is a concise but informative name representing your changes, e.g. `feat/your-cool-feature` and `chore/new-doc`. PR titles are based off of the branch name, so for the examples just used they __should be__ "feat: Your cool feature" and "chore: New doc".
7
+
Branch names **must** follow a certain structure, which is `branch-prefix/branch-name`. The `branch-prefix` corresponds to one of the conventional commit types defined above and the branch name is a concise but informative name representing your changes, e.g. `feat/your-cool-feature` and `chore/new-doc`. PR titles are based off of the branch name, so for the examples just used they **should be** "feat: Your cool feature" and "chore: New doc".
8
8
9
9
## Protected Branches
10
10
11
11
The Firefly team develops code and pushes PRs on certain protected branches. The following three branches are protected:
12
12
13
-
-`main`: contains the code for Firefly Desktop v1.
14
-
-`develop`: contains the code for Firefly Shimmer Desktop
13
+
-`main`: contains the code for Firefly Desktop v1.
14
+
-`develop`: contains the code for Firefly Shimmer Desktop
0 commit comments