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.

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

Fix/update documentation #23

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Conversation

sanderhollaar
Copy link
Contributor

No description provided.

@sanderhollaar sanderhollaar requested a review from ivard July 20, 2022 06:46
@sanderhollaar sanderhollaar self-assigned this Jul 20, 2022
Copy link
Member

@ivard ivard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice and clear documentation. I had some comments still about some steps.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
1. Start IRMA server (in the root directory of this project)
```bash
~/go/bin/irma server --static-path ./webapp/build
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

go install should add the binary to your PATH too, at least that's the case with me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to document that step or can we expect either the package manager or the reader to take care of that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you installed Go in a way that the ~/go/bin was not added to your PATH automatically, then it's probably better to either mention this or keep it the way you did it now.

README.md Outdated
};
EOD
)
cp webapp/config.example.js build/assets/config.js
cp -a webapp/ src/main/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that final step is not needed to copy webapp to src/main, because the Java-part does not need it.

Copy link
Contributor Author

@sanderhollaar sanderhollaar Jul 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

without the copy:

$ gradle appRun

> Task :appRun
You're running webapp in hard inplaceMode: Overlay and filtering features of gretty will be disabled!

11:21:35 WARN  Web application not found /tmp/irma_email_issuer/src/main/webapp
11:21:35 WARN  Failed startup of context o.a.g.JettyWebAppContext@5a709816{/irma_email_issuer,null,null}{/tmp/irma_email_issuer/src/main/webapp}
java.io.FileNotFoundException: /tmp/irma_email_issuer/src/main/webapp

README.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants