mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-23 20:47:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fixes #478 - adds note about web ui already being packaged (#480)

Browse source
This commit is contained in:
James Hodgkinson 2021-06-16 07:58:46 +10:00 committed by GitHub
parent 6b696b1923
commit a7e6f0c9e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
DEVELOPER_README.md
View file

@ -55,12 +55,11 @@ cd kanidm
git remote add myfork git@github.com:<YOUR USERNAME>/kanidm.git git remote add myfork git@github.com:<YOUR USERNAME>/kanidm.git
``` ```
Select and issue (and always feel free to reach out to us for advice!), and create a branch to Select an issue (always feel free to reach out to us for advice!), and create a branch to start working:
start working:
``` ```
git branch <feature-branch-name> git branch <feature-branch-name>
git checkout <feature-branche-name> git checkout <feature-branch-name>
cargo test cargo test
``` ```
@ -73,7 +72,7 @@ git push <myfork/origin> <feature-branch-name>
``` ```
If you get advice or make changes, just keep commiting to the branch, and pushing to your branch. If you get advice or make changes, just keep commiting to the branch, and pushing to your branch.
When we are happy with the code, we'll merge in github, meaning you can now cleanup your branch. When we are happy with the code, we'll merge in github, meaning you can now clean up your branch.
``` ```
git checkout master git checkout master
@ -88,12 +87,11 @@ If you are asked to rebase your change, follow these steps:
``` ```
git checkout master git checkout master
git pull git pull
git checkout <feature-branche-name> git checkout <feature-branch-name>
git rebase master git rebase master
``` ```
Then be sure to fix any merge issues or other comments as they arise. If you have issues, you can Then be sure to fix any merge issues or other comments as they arise. If you have issues, you can always stop and reset with:
always stop and reset with:
``` ```
git rebase --abort git rebase --abort
@ -129,12 +127,14 @@ In a new terminal, you can now build and run the client tools with:
### Building the Web UI ### Building the Web UI
The web ui uses rust wasm rather than javascript. To build this you need to setup the environment. __NOTE:__ There is a pre-packaged version of the Web UI at `/kanidmd_web_ui/pkg/`, which can be used directly. This means you don't need to build the Web UI yourself
The web UI uses rust wasm rather than javascript. To build this you need to set up the environment.
cargo install wasm-pack cargo install wasm-pack
npm install --global rollup npm install --global rollup
Then you are able to build the ui. Then you are able to build the UI.
cd kanidmd_web_ui/ cd kanidmd_web_ui/
./build_wasm.sh ./build_wasm.sh