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

Overview: connect the overview page to the backend #46

Closed
fadeev opened this issue Apr 21, 2022 · 5 comments · Fixed by #76
Closed

Overview: connect the overview page to the backend #46

fadeev opened this issue Apr 21, 2022 · 5 comments · Fixed by #76
Assignees
Labels

Comments

@fadeev
Copy link
Contributor

fadeev commented Apr 21, 2022

Right now this page is static, it has to be connected to the backend.

Screen Shot 2022-04-21 at 11 20 12

@fadeev
Copy link
Contributor Author

fadeev commented Apr 21, 2022

We have the following sections and corresponding content sources:

  • readme
    • readme.md
  • whitepaper
    • config file
  • roadmap
    • config file and the blockchain API
  • tokenomics
    • config file and (probably) the blockchain API
  • vesting schedule
    • blockchain API (may not be ready yet)
  • team
    • config file and the blockchain API
  • community
    • config file

Let's brainstorm on how the content may be structured.

assets/
  readme.md
  project.yml
  images/

project.yml:

project:
  whitepaper:
    url: "https://example.org/whitepaper.pdf"
  roadmap:
    milestones:
      - title: Milestone 3
        date: 2022-05-05
        description: Brief description ipsum dolor sit amet, consectetur adipiscing elit...
  tokenomics:
    distribution:
      - title: Marketing
        share: 25%
  team:
    members:
      - name: Bob
        title: CEO
        description: Bio lorem consequat efficitur iaculis. Nam eu tincidunt nunc...
  links: # Not sure about this
    - type: twitter
      url: https://twitter.com/example

@lumtis
Copy link

lumtis commented Apr 21, 2022

When you mention blockchain API, do you mean setting the values in the metadata of the chain or the campaign in the blockchain?
Why not have everything on Github?

@fadeev
Copy link
Contributor Author

fadeev commented Apr 21, 2022

@lubtd blockchain API refers to the data we can get from the chain. For example, we can get the dates for the testnets and map them on the timeline. A coordinator most likely should be in the team section. Same with the tokenomics, whatever we can get from the chain, we'll display it on the overview page, the rest will be fetched from Github.

@fadeev
Copy link
Contributor Author

fadeev commented Apr 21, 2022

To answer your question, yes, almost all of the static data will be stored on GH.

@scottcarterco
Copy link

scottcarterco commented Apr 21, 2022

Hey Team,

A few thoughts based on the config file structure example.

  1. In design, we had structured the milestone date as month and year designation to better align with the examples we observed in the wild where dates were more loose than precise to provide flexibility. Proposed Modification to date would exist only on output in the UI.
    date: 2022-05-04 would translate to "May 2022"
  2. Are we planning on organizing the Roadmap steps based on date or based on order in the config file?
  3. We should consider including comments in the config file to help guide the coordinator for proper formatting to display properly on our site.
  4. I would propose that we change the label of “steps” to “milestones” as a roadmap reflects milestones for a project. Proposed modification using the Keplr integration example from the screenshot:
  roadmap:
    milestones:
      - title: Keplr integration
        date: 2022-06-04
        description: Brief description ipsum dolor sit amet, consectetur adipiscing elit...
  1. The social links example would support up to 3 specific link types: Twitter, Discord, Telegram. We have designed the UI to modify based on whether the coordinator provides 0, 1, 2 or all 3. With that in mind, here’s how I could see the config file being modified a bit…
  social_links:
    - twitter: display
      url: https://twitter.com/example
 - discord: display
      url: https://discord.com/invite/example
 - telegram: hide
      url: https://t.me/joinchat/example

Note: Would a display/hide value help the coordinator specify what should display on the project as opposed to just deleting the content or commenting it out?

@fadeev fadeev added the API label Apr 26, 2022
@JoseRFelix JoseRFelix self-assigned this Apr 26, 2022
@fadeev fadeev changed the title Connect the overview page to the backend Overview: connect the overview page to the backend May 1, 2022
@fadeev fadeev linked a pull request May 4, 2022 that will close this issue
@fadeev fadeev added this to the Incentivized Testnet milestone May 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants