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

Decide what to do with the examples/signify-react-ts project #165

Closed
lenkan opened this issue Dec 6, 2023 · 4 comments
Closed

Decide what to do with the examples/signify-react-ts project #165

lenkan opened this issue Dec 6, 2023 · 4 comments
Assignees

Comments

@lenkan
Copy link
Collaborator

lenkan commented Dec 6, 2023

By inspection, I can tell the code in here has not been kept up to date with the recent changes, so it will not work in all scenarios. The Credentials.tsx file for example is not updated.

Should we keep it? If yes, we probably need to add some steps to the workflow to test that it works. If we do that, we can decide what level to keep it at:

  • Static type-checking. Could be sufficient, but currently there are a lot of any types which will effectively turn off typechecking.
  • Unit testing. Personally I do not see much benefit in this since it is a testing project in itself.
  • E2E testing. Could be run with e.g. puppeteer to ensure that the code works in a browser environment. But is probably a bit more work than it is worth at the moment.
@rodolfomiranda
Copy link
Collaborator

That code was pushed initially to show how can signify-ts be implemented in a web app and because we were having problems running signify in node. As you mentioned is totally outdated.
My opinion is if we are going to keep hosting that sample it should only be to demonstrate how signify can be added into a web app. It should be a really simple code with basic functionalities such as boot, connect, create AID (single sig, no wits) and list AIDS. SO we do not need to keep it up to date often. If someone what to contribute with a more complex react app, we should create a separate repo.

@kentbull
Copy link
Contributor

kentbull commented Dec 6, 2023

I agree that we should keep this example in the codebase. I would be willing to help maintain it. So many recent changes are part of why we haven't updated it. With Phil's recent work #166 being complete then we can have an end-to-end flow with issue, admit, and present so now is a good time to update the webapp.

Having a sample one in this repo seems like a good idea and I agree that the tests for this sample app should be run along with tests for the repo.

@pfeairheller
Copy link
Member

Discussed on 12/7 dev call, decision to move to its own repo.

@kentbull
Copy link
Contributor

kentbull commented Dec 7, 2023

This is addressed by #170

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

No branches or pull requests

4 participants