datopian / portal.js.bak

🌀 The JS data presentation framework. For a single dataset to a full catalog.
https://portal-78qurbwf9-datopian1.vercel.app/
MIT License
22 stars 2 forks source link

[epic] MVP of Full Portal/Catalog app: site components, bootstrap app etc (June 2020) #16

Closed rufuspollock closed 3 years ago

rufuspollock commented 4 years ago

A decoupled data portal frontend built in javascript. See RFC for background: https://github.com/ckan/ideas/blob/master/rfcs/0005-decoupled-frontend.md

Acceptance criteria

Tasks

Overview

graph TD

bootscript[Boot script]
docs[Documentation]

boot[Boot up] --> mvpsite[MVP of site]
mvpsite --> bootscript
mvpsite --> docs
mvpsite --> morecomp[More Components]
mvpsite --> auth[Authentication]
bootscript --> announce
docs --> announce[Announce]

classDef done fill:#21bf73,stroke:#333,stroke-width:1px;
classDef nearlydone fill:lightgreen,stroke:#333,stroke-width:1px;
classDef inprogress fill:orange,stroke:#333,stroke-width:1px;
classDef next fill:lightblue,stroke:#333,stroke-width:1px;

class boot done;
class mvpsite nearlydone;
class inprogress inprogress;
class bootscript next;

Detailed

graph TD

analysis[Analysis]
stub[Stub]
prelim[Preliminaries]

subgraph MVP of overall app
  analysis --> stub
  stub --> prelim
  prelim --> frontpage[Front page]

subgraph v0.1 MVP of a portal UI #9
  frontpage --> search
  frontpage --> search[Search page]
  search --> showcase[Dataset showcase]
  showcase --> showcase2[Resource showcase]
  search --> cms["CMS integration (Wordpress)"]
  showcase2 --> org[Org page]
end

datalayer[Data layer => GraphQL]

prelim --> datalayer
datalayer --> livesite{Live Site}
cms --> livesite
org --> livesite

end

subgraph Docs
  prelim --> readme[Stub README with install etc]
end

theme

subgraph v1
end

subgraph Docs
end

classDef done fill:#21bf73,stroke:#333,stroke-width:1px;
classDef nearlydone fill:lightgreen,stroke:#333,stroke-width:1px;
classDef inprogress fill:orange,stroke:#333,stroke-width:1px;
classDef next fill:lightblue,stroke:#333,stroke-width:1px;

class stub done;
class prelim done;
class frontpage done;
class datalayer done;
class search done;
class cms done;
class showcase done;
class showcase2 inprogress;
class org next;
graph TD

subgraph Key
  done[Done]
  nearlydone[Nearly Done]
  inprogress[In Progress]
  next[Next Up]
end

classDef done fill:#21bf73,stroke:#333,stroke-width:1px;
classDef nearlydone fill:lightgreen,stroke:#333,stroke-width:1px;
classDef inprogress fill:orange,stroke:#333,stroke-width:1px;
classDef next fill:lightblue,stroke:#333,stroke-width:1px;

class done done;
class nearlydone nearlydone;
class inprogress inprogress;
class next next;

Preliminaries

Data Layer

Documentation

anuveyatsu commented 4 years ago

Created next epics:

v0.2 - #33 v0.3 - #34

anuveyatsu commented 4 years ago

@rufuspollock could you pleas clarify a bit about these tasks:

Refactoring of the MVP to move out components and library code

  • components
  • Data Access library
rufuspollock commented 4 years ago

@anuveyatsu

Is that clearer?

steveoni commented 3 years ago

While working with the portal js, I was experiencing an error, while trying to view the Dataset resources, as illustrated here #49 . Hence I created a pull request #50 to fix the error

steveoni commented 3 years ago

Currently, working on the create-portal-app. I created a package to obtain portal.js from Github and install the necessary packages, by specifying either NPM or Yarn. here is the repo to the code.

This afternoon I and Thadeu discuss and we find out that we are working on the same thing, Hence some adjustments will be made to my former approach. So Thadeu and I will be working on it.

cotts commented 3 years ago

I've created a pull request related to create-portal-app for review #33 - #52

steveoni commented 3 years ago

Pull request #51 adds i18n feature to Portal.js. Currently supporting English and French. All other languages can be added by subsequent users.

steveoni commented 3 years ago

Pull requests #54 adds google analytics to Portal.js.

rufuspollock commented 3 years ago

FIXED / WONTFIX. A large portion of this was done and is in https://github.com/datopian/portal.js/tree/master/examples/catalog. For parts remaining these will probably be addressed in examples and docs and so merit somewhat different issue so closing this for now.