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

Create website for testing Token generation #16 #17

Merged
merged 31 commits into from
Oct 24, 2024
Merged

Create website for testing Token generation #16 #17

merged 31 commits into from
Oct 24, 2024

Conversation

munyanezaarmel
Copy link
Contributor

@munyanezaarmel munyanezaarmel commented Oct 3, 2024

Brief summary of the change made

  • added index.html file which includes everything for OpenPaygo token website

Closes: #16

Are there any other side effects of this change that we should be aware of?

none

Describe how you tested your changes?

  • by referring to the unit tests. token matches the format of the token generated in the browser

image

Pull Request checklist

Please confirm you have completed any of the necessary steps below.

  • Meaningful Pull Request title and description
  • Changes tested as described above
  • Added appropriate documentation for the change.
  • Created GitHub issues for any relevant followup/future enhancements if appropriate.

@munyanezaarmel
Copy link
Contributor Author

@dmohns can i get your review

@dmohns
Copy link
Member

dmohns commented Oct 7, 2024

Nice, thanks @munyanezaarmel the website look good.

However, you are essentially hardcoding the entire repositories code into the HTML file, which is not exactly what we want.

Could me make it more like this:

  • Use a JavaScript website framework of your choice
  • Install the OpenPAYGO-js using npm

Build the website using npm production build.

@munyanezaarmel
Copy link
Contributor Author

Hello @dmohns,

Thank you for your review. I've decided to proceed with React/Next.js for my project. However, I'm encountering an issue with package accessibility. Despite successful installation, I'm unable to access the package in my code.
A significant concern is the absence of an index.js file that clearly shows which functions are available to be called. This omission is causing confusion, as it's unclear which functions are intended for use and which are not.
Could you please provide documentation on how to properly use this package? Specifically, it would be helpful to have:

  • A clear list of exported functions and their purposes
  • Examples of how to import and use these functions
  • Any configuration or setup required

For reference, I'm looking for something similar to the documentation style found on the npm website for packages like 'decoders' (https://www.npmjs.com/package/decoders).
image

@beesaferoot beesaferoot mentioned this pull request Oct 14, 2024
4 tasks
Copy link
Member

@dmohns dmohns left a comment

Choose a reason for hiding this comment

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

Few comments in the code.

Could you move the entire website generation code into a folder called website rather than openpaygo-token-generator ?

src/index.html Outdated Show resolved Hide resolved
openpaygo-token-generator/README.md Outdated Show resolved Hide resolved
openpaygo-token-generator/src/openpaygo.d.ts Outdated Show resolved Hide resolved
@munyanezaarmel munyanezaarmel requested a review from dmohns October 22, 2024 09:59
Copy link
Member

@dmohns dmohns left a comment

Choose a reason for hiding this comment

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

LGTM, could you fix the failing linters, then we can merge this :shipit:

.github/workflows/deploy.yml Outdated Show resolved Hide resolved
.github/workflows/deploy.yml Outdated Show resolved Hide resolved
dmohns
dmohns previously approved these changes Oct 24, 2024
@dmohns dmohns merged commit ecd216a into EnAccess:main Oct 24, 2024
6 checks passed
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.

Create website for testing Token generation
3 participants