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

Minimal front-end for launch #12

Closed
rabernat opened this issue Feb 6, 2022 · 3 comments
Closed

Minimal front-end for launch #12

rabernat opened this issue Feb 6, 2022 · 3 comments
Assignees

Comments

@rabernat
Copy link

rabernat commented Feb 6, 2022

It would be nice to have a minimal working read-only front-end for when we launch. Basically just a vanilla browse interface for the three data models currently defined in the public API.

  • bakeries (note that the current API doesn't have enough info on bakeries, see Proposal: eliminate bakeries.yaml - split into database entry and bakery-specific config roadmap#47)

    • /bakeries/ routes to a paginated, browseable list of bakery cards
    • /bakeries/{name} details on that bakery, links to its recipes
  • feedstocks (e.g. pangeo-forge/noaa-oisst-avhrr-feedstock)

    • /feedstocks/ routes to a paginated, browseable list of feedstock cards
    • /feestocks/gh/pangeo-forge/noaa-oisst-avhrr-feedstock is the landing page for that feedstock, within links to connected recipes and datasets
  • recipes (technically "recipes runs", but I think recipes is a better name to use on the front end size).

    • /recipes/ routes to a paginated, browseable list of recipe cards
    • /recipes/{id} gives details on that recipe run.

    A recipe may or may not produce a dataset. If so, it will be available via recipe.dataset_public_url. I still think we should have a separate browse path for...

  • datasets, even though there is a 1:1 relationship between datasets and recipes, I think many people will just want to browse the data

One way to limit scope and make things easy for us would be to not try to support any search yet. Just read-only browsing through the database contents, with a pretty direct relationship between the API and what's on the screen.


For anyone thinking of picking this up, note that we are using

  • Bulma as our CSS framework
  • Buefy as our js component library
  • Axios to consume APIs.

That should be all that's needed to wire this up.

@rabernat
Copy link
Author

rabernat commented Feb 7, 2022

Based on conversation with @jhamman on slack, I should note that we are open to switching frameworks (e.g. move to React) if someone is willing to write, deploy (in time for OSM), and maintain the code. That sounds like a heavy lift to me, but I'd love to be proven wrong! 😉

@jhamman jhamman transferred this issue from pangeo-forge/pangeo-forge-vue-website Feb 28, 2022
@jhamman
Copy link

jhamman commented Feb 28, 2022

@rabernat - I transferred this issue here so that we can continue the conversation / design conversation.

What we have now in this repo is a re-implementation of the Vue site in Next.js. The site now includes a number of new routes including the /dashboard/feedstocks, /dashboard/bakeries, and /dashboard/recipe-runs.

The site is currently deployed at https://pangeo-forge-org.vercel.app/

The major todo's are:

  • Work through a long list of theme/style fixes (@rabernat, I think you were saving some feedback so now is a good time)
  • Get feedback on the router layout, do we like /dashboard/... or should we flatten this (@rabernat and @cisaacstern)
  • Get feedback on the individual pages (the feedstock and recipe-run pages need the most inspiration)
  • Sketch out a datasets or catalog route
  • Stage assets, favicon, etc. in site (currently referencing external objects)
  • Transfer domain name / dns settings to vercel
  • Configure pagination for feedstocks / recipe runs.

@rabernat
Copy link
Author

Fantastic Joe. Will you be attending the 2pm meeting today? If so I'll ask you to run through this for the team.

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

3 participants