Make the framework more general

jkomoros commented 5 years ago

[x] Stop hard-coding admin IDs (#184)
[x] Allow changing the app title (incl in compendium-app.appTitle) and in the header of the webapp
[x] compendium-app --> card-app
[x] Write documentation for how to create a stub of starter content in the database (or provide a starter stub backup in the project that can be booted up), and update README
[x] The links at the top of the app to sections should not be hard-coded but based on the values of sections
[ ] Some kind of theming system (how hard could that possibly be??)
[x] gulpfile.js constants should be factored out into a config
[x] api keys factored out into secret config
[ ] Add .firebase directory to .gitignore
[ ] The tweets panel in the card-info-panel should only show up if there's a twitter bot configured. And it should point to the configured twitter bot (currently hardcoded to cardscompendium)
[ ] actions/app.js has DEFAULT_CARD set to the section head for half-baked, but ideally that would be more reselient
[ ] Get set up using the firebase emulator to test functions (https://firebase.google.com/docs/functions/local-emulator and or just https://firebase.google.com/docs/functions/local-shell ?) https://firebase.google.com/docs/functions/unit-testing
[ ] the domain, from/to files, etc should be popped out of functions/index.js. Can use a file: local package import for config. The config files would move to be in the config/ package folder, with the package.json having just a name and version field (https://docs.npmjs.com/creating-a-package-json-file)
[x] Undo the changes that moved config.SECRET.json to be in a config npm package, because it's hard to do both (https://medium.com/@giltayar/native-es-modules-in-nodejs-status-and-future-directions-part-i-ee5ea3001f71)
[x] Initial starter data for the project (e.g. base sections, a starter card)
[ ] Figure out how to have the inject-config task run continuously whenever config.SECRET.json changes
[x] Rename the repo to something more general
[ ] first run instructions should remind you to generate favicon/manifest
[x] Make the colors for word-clouds not be hard coded (hard-coded in both word-cloud element as well as the wordcloudFromFingerprint method
[ ] Support domain not being set in config (default to firebase.prod . whatever the site name is)
[x] Support not having a dev firebase project (in gulp commands, documentation, etc. Make sure gulp reset-dev doesn't run)
[x] the main-view header title should use the app_title configuration variable
[ ] Allow defining custom theme colors
[x] gulpfile icon generation should not bake in 'The Compendium'
[ ] delete keys from the functions environment variable that are now provided in the config.SECRET.json
[ ] Add a setting up custom domain (including the authentication domain being whitelisted) section of README
[x] Document first production deploy (e.g. enabling hosting)
[x] Document dev account
[x] Document backups
[x] Document emails
[ ] Document twitter (incl screenshot service)
[x] remove gulpfile.js dependency on 'gs://complexity-compendium-backup`
[x] Create a config.PUBLIC.js tha tcontains the non-sensitive keys
[x] pop out VAPID from database.js into config.SECRET.js (what is vapid?)
[ ] some kind of mechanism to push server config values based on the values in config.SECRET.js (e.g. look for postmate key in the secret file and make sure it's set that way in server)
[x] generate index.html
[ ] Regenerate firebase API keys
[ ] Figure out a way to not send the non-current mode (e.g. dev, when prod is active) mode keys to client
[ ] If dev settings not provided use prod settings (for example look for process.env.GCLOUD_PROJECT https://firebase.google.com/docs/functions/config-env)
[x] Initial Set up should only create a single section, Default
[ ] the tutorial card id for stars and reading list are hard-coded in selectors.js. Part of #274
[x] Allow configuring the Google Analytics ID

jkomoros commented 4 years ago

Config should be in a config.SECRET.json file, the same config for firebase config sets and the gulp file sets

jkomoros commented 4 years ago

Have a gulp regenerate-from-config that takes a config.SECRET.json and:

regenerates index.html with the right title
regenerates ES6 import-style config.SECRET.js for the webapp
regenerates CJS style config.SECRET.json for cloud functions
regenerates firestore.rules (once we have the default permissions object support)

TODO:

[ ] Make sure that all the template output has .gitignore set for them

jkomoros / card-web

Make the framework more general #164