search

FNNDSC / cube-design

All CUBE related designs
MIT License
5 stars 2 forks source link

ChRIS Website: Design for Code section of chrisproject.org: http://chrisproject.org/code #19

Open mairin opened 4 years ago

mairin commented 4 years ago

Design assets should be placed in a new "Code" directory under the main "website" directory in this repo.

This page should serve as an overview of the code available at github.com/fnndsc. At the least it should highlight the pinned repos. You may want to look into whether or not GitHub has an API that lets you grab some of the data about the repos or embed info boards about them in the website.

We want someone to be able to visit this page, get an idea of the categories of code we have (ChRIS, ChRIS core containers like pfman, pfioh, etc, ChRIS Store, and all of the plugins and utilities) and also get an idea of how active and alive the project is.

Abhir-24 commented 3 years ago

@mairin can u pls explain a little bit more as what is to be done in this issue?

mairin commented 3 years ago

@Abhir-24 sure! What I am looking for here is a review of the github API for pulling data about the repos under the github.com/fnndsc organization so it can be displayed here. For example, I would like a list of just the pinned repos at fnndsc. And then implement it using the github api.

Does this make more sense?

khushaliRatanghayara commented 3 years ago

Hello @mairin,i am an outreachy applicant,i would like to work on this issue.

khushaliRatanghayara commented 3 years ago

hi @mairin, i think it can be implemented using GraphQL, correct me if this approach of solving the issue is wrong.

zrthxn commented 3 years ago

I think GraphQL would be a bit overkill for something simple like this since the website is made with Vanilla JS. Adding a GQL client wouldn't make sense here. It can probably be done with the REST API. If someone else isn't working on this I'd like to take this up.

jennydaman commented 3 years ago

GraphQL can be something fun to learn! Also we could use it without putting a GraphQL client in the client app. Instead, we could use templates (similar to pre-rendering) to generate static pages. We would rebuild the website monthly using cron on Github Actions. The advantage of this would be better performance, fewer cross-site requests, and search-engine optimization (SEO).

GraphQL is still optional for the templating/prerendering implementation but it's a good opportunity to learn up and coming technologies.

angelicapages commented 3 years ago

I'm interested in working with GraphQL and learning more about it! I'll take the issue 😄