cdp-frontend, enable npm install for the entire CDP web application

evamaxfield commented 4 years ago

Use Case

Please provide a use case to help us understand your request in context The backend repo was designed to be incredibly reusable and generalized, however the current deployment was made very tailor fit for Seattle and has few reusable components.

Solution

Please describe your ideal solution An npm package that contains all the necessary shared components for any CDP deployment. These components can be updated freely and each deployment can simply then pin which version of cdp-frontend to use in their package.json. The end goal is to have a similar "single config file" for deployment for the front-end that the backend currently has.

Alternatives

Please describe any alternatives you've considered, even if you've dismissed them Allow people to fork "councildataproject/seattle" and make their own customizations. This is much harder for us to maintain and support in the case we ever do deploy in multiple cities.

Stakeholders

Please add any individual person or team's that should be brought in for discussion on the project Front-end, UX

Major Components

Please add any major components that need to be done for this project

[x] Core components rewritten in typescript with tests
[x] New components and components with new designs added or updated
[x] Single config file to deploy
[x] Current instances converted over to using cdp-frontend

Dependencies

Please add any other major or minor project dependencies here

[x] (required) database redesign

Other Notes

Please add any extra notes here

evamaxfield commented 4 years ago

A config for the websites may look something like:

{
    "database": ...,
    "filestore": ...,
    "styling": {
        "primary": ...,
    "secondary": ...
    },
    "extra_data": {
        "city council link": ...
    }
}

evamaxfield commented 3 years ago

Still in progress! Although we have realized that we don't need to put database and file storage configuration into the config. The config will strictly be styling and extra content / links.

evamaxfield commented 3 years ago

:tada: closed by https://github.com/CouncilDataProject/cdp-frontend/pull/104

Minor bugs and more features remain but the central idea / functionality is inplace and already used in https://councildataproject.org/test-deployment/#/

CouncilDataProject / cdp-roadmap