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(gnoweb): rework & Implement new gnoweb design #3195

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

Conversation

gfanton
Copy link
Member

@gfanton gfanton commented Nov 25, 2024

address #3191

Reworking the gnoweb package:

  • Implement gnoweb new interface design(cc @alexiscolin).
  • Move Markdown rendering to the server to enhance speed and security. This change also simplifies the implementation of new components, making it more standardized as a Go library.
  • Aim to keep dependencies minimal, using only goldmark for Markdown and chroma for code highlighting, with almost no (in)direct dependencies.
  • Transition to Tailwind for simplicity and maintainability.
  • Retain all features from the previous gnoweb iteration.

Preview

  • Home
    Screenshot 2024-11-25 at 19 39 54

  • Source
    Screenshot 2024-11-25 at 19 41 25

  • Docs
    Screenshot 2024-11-25 at 19 45 16

TODO:

  • port and adapt all previous tests to ensure compatibility (it should not take too long)
  • Some cleanup and restructuring + linting.

Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
@gfanton gfanton requested a review from alexiscolin November 25, 2024 18:51
@github-actions github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Nov 25, 2024
@alexiscolin alexiscolin added the 🌍 gnoweb Issues & PRs related to gnoweb and render label Nov 26, 2024
@Kouteki Kouteki added the in focus Core team is prioritizing this work label Nov 27, 2024
@zivkovicmilos zivkovicmilos self-requested a review November 29, 2024 03:42
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Dec 3, 2024

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • SKIP: Do not block the CI for this PR
  • Determine if infra needs to be updated before merging
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🟢 The pull request head branch must be up-to-date with its base (more info)

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: gfanton/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

The pull request head branch must be up-to-date with its base (more info)

If

🟢 Condition met
└── 🟢 On every pull request

Then

🟢 Requirement satisfied
└── 🟢 Head branch (gfanton:feat/gnoweb-rework) is up to date with base (master): behind by 0 / ahead by 101

Manual Checks
**SKIP**: Do not block the CI for this PR

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission
Determine if infra needs to be updated before merging

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: master
    └── 🟢 Or
        ├── 🔴 A changed file matches this pattern: Dockerfile
        ├── 🟢 A changed file matches this pattern: ^misc/deployments (filename: misc/deployments/staging.gno.land/docker-compose.yml)
        ├── 🔴 A changed file matches this pattern: ^misc/docker-
        ├── 🔴 A changed file matches this pattern: ^.github/workflows/releaser.*\.yml$
        └── 🔴 A changed file matches this pattern: ^.github/workflows/portal-loop\.yml$

Can be checked by

  • team devops

@leohhhn leohhhn self-requested a review December 3, 2024 16:35
gno.land/pkg/gnoweb/app.go Outdated Show resolved Hide resolved
gno.land/pkg/gnoweb/alias.go Outdated Show resolved Hide resolved
@leohhhn
Copy link
Contributor

leohhhn commented Dec 12, 2024

Hey, please confirm with me directly before merging and updating the testX/portal loop gnoweb images; we will be sharing an announcement on social media about the new design revamp and we need to coordinate it. cc @sw360cab

gfanton and others added 21 commits December 12, 2024 10:21
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
Signed-off-by: gfanton <[email protected]>
gno.land/pkg/gnoweb/README.md Outdated Show resolved Hide resolved
Comment on lines 2 to 3

This README provides instructions on how to set up and run Gnoweb for development purposes.
Copy link
Contributor

@leohhhn leohhhn Dec 12, 2024

Choose a reason for hiding this comment

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

We can just add a 2 liner on what gnoweb is along this:

gnoweb is a universal web frontend for the gno.land blockchain. It is built in Go, with xyz for doing xyz. It communicates with the remote RPC of a gno.land network to fetch data about realms and packages, ...

Copy link
Member Author

Choose a reason for hiding this comment

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

I've updated it with a minimal description

gno.land/pkg/gnoweb/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
🌍 gnoweb Issues & PRs related to gnoweb and render in focus Core team is prioritizing this work 📦 ⛰️ gno.land Issues or PRs gno.land package related
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

[gnoweb] Long text popping out [gnoweb] Display line numbers on package & realm source code renders
8 participants