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

feat(examples): add simple userbook realm #1949

Merged
merged 43 commits into from
Apr 26, 2024

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented Apr 18, 2024

Description

This PR arose out of a necessity to have a simple, permissionless realm for demonstration purposes. The idea is that people can sign up once with their address, and the Render function will paginate 50 addresses per page, as well as include a UI to go to the next/previous page. This realm will serve 3 purposes:

  • Show how to do pagination
  • Show how to use Render in harmony with gnoweb
  • Exist as a simple entry point for new developers testing out the chain. This realm will be used as an example in the Getting started section in the docs.
Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@leohhhn leohhhn self-assigned this Apr 18, 2024
@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Apr 18, 2024
Copy link

codecov bot commented Apr 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.62%. Comparing base (cc207f8) to head (e54e145).
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1949      +/-   ##
==========================================
- Coverage   48.28%   46.62%   -1.66%     
==========================================
  Files         409      492      +83     
  Lines       62217    69966    +7749     
==========================================
+ Hits        30039    32622    +2583     
- Misses      29668    34622    +4954     
- Partials     2510     2722     +212     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leohhhn leohhhn marked this pull request as ready for review April 23, 2024 09:13
@leohhhn leohhhn requested review from a team as code owners April 23, 2024 09:13
Copy link
Contributor

@deelawn deelawn left a comment

Choose a reason for hiding this comment

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

Mostly nits, but a couple things to take a closer look at.

examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination.gno Outdated Show resolved Hide resolved
examples/gno.land/r/demo/pagination/pagination_test.gno Outdated Show resolved Hide resolved
@moul
Copy link
Member

moul commented Apr 24, 2024

We can merge it, but not with r/demo/pagination as explained earlier. Also, avoid merging it with r/demo/registration or r/demo/signup, as they resemble "the official gnoland registration system." Kindly suggest a new name, make the change, and notify me to proceed. 👍

@leohhhn leohhhn changed the title feat(examples): add pagination demo feat(examples): add simple userbook realm Apr 25, 2024
@leohhhn
Copy link
Contributor Author

leohhhn commented Apr 25, 2024

@moul renamed it to r/demo/userbook - how does that sound?

@leohhhn leohhhn merged commit f660be5 into gnolang:master Apr 26, 2024
74 checks passed
@leohhhn leohhhn deleted the feat/add-paginated-signup branch April 27, 2024 12:48
leohhhn added a commit that referenced this pull request May 13, 2024
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR introduces a change to the Getting Started section in the docs.
As discussed with @moul, it makes sense to have `gnodev` take the
spotlight in the "Local setup" section.

With this PR, I've modified the "Local setup" section to reflect the use
of `gnodev`. I've moved the "Setting up a local chain" & "Premining
balances" out of this section, as they will belong better in a new
section which will contain new chain initialization flows.

~Dep. on #1949

Latest preview:
https://www.loom.com/share/a9d354b7234843fb8108f1698cc28b5c?sid=92850b75-5153-4f8b-aa0d-bb9d3aa0d6fd

<details><summary>Contributors' checklist...</summary>

- [x] Added new tests, or not needed, or not feasible
- [x] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [x] Updated the official documentation or not needed
- [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [x] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>
DIGIX666 pushed a commit to kazai777/gno that referenced this pull request May 15, 2024
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR introduces a change to the Getting Started section in the docs.
As discussed with @moul, it makes sense to have `gnodev` take the
spotlight in the "Local setup" section.

With this PR, I've modified the "Local setup" section to reflect the use
of `gnodev`. I've moved the "Setting up a local chain" & "Premining
balances" out of this section, as they will belong better in a new
section which will contain new chain initialization flows.

~Dep. on gnolang#1949

Latest preview:
https://www.loom.com/share/a9d354b7234843fb8108f1698cc28b5c?sid=92850b75-5153-4f8b-aa0d-bb9d3aa0d6fd

<details><summary>Contributors' checklist...</summary>

- [x] Added new tests, or not needed, or not feasible
- [x] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [x] Updated the official documentation or not needed
- [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [x] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages.
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants