@planningcenter/doxy-web

doxy-web

Unified styles for Church Center Web.

Links

• NPM package
• Github repository
• Storybook (documentation)

Getting Started

cd Code
git clone [e-mail]:planningcenter/doxy-web.git
cd doxy-web
yarn install

Contributing Guide

• make changes in branched forked from main
• release candidate package versions can be created from any branch (see below) and used for testing on staging (following -rc.0 naming conventions)
• because main has branch protection, final version updates to the NPM package should published from your feature branch as the last commit before the approved PR is merged.

Development Scripts:

💅 Making SCSS changes:

• yarn link (in doxy-web)
• yarn link @planningcenter/doxy-web (in church-center or proxied app)
• yarn install (in church-center or proxied app)
• yarn develop (in doxy-web): listens for SCSS changes and compiles to CSS
• changes reflected in CCW for local testing

⚠️ run yarn unlink @planningcenter/doxy-web and yarn install --check-files to return package to published version from NPM

⚛️ Making component changes:

• yarn start opens Storybook (compiles SCSS, Hot Module Reloading, etc)
  • local pco-box: http://localhost:3000
  • pco-cloud-box: https://churchcenter.test:3000
• yarn build compiles SCSS & JS modules using Rollup

⚠️ SCSS/JS changes reflected in Storybook are not available in CCW without running yarn build or yarn develop

🚀🤞 Publishing prerelease version to NPM:

• commit changes
• npm login
• yarn prerelease
• in CLI, choose prerelease if the version shown follows our Planning Center release strategy. If not, choose other and manually add the version. (For example, if the final version will be 1.19.0, the first alpha version would be 1.19.0-rc.0)
• after alpha version is published, run yarn add @planningcenter/doxy-web@next in church-center or proxied app

🚢📦 Deploying package to NPM (before merging PR):

• npm login
• yarn deploy:package
• in CLI tool, choose semantic version to reflect level of changes made:

v1.2.3
 ^ ^ ^
 │ │ └─ Patch: Documentation and fixes
 │ └─── Minor: Additions
 └───── Major: Deletions and edits

• add version/change description on Github and create new release (page will open automatically in browser after deployment is complete)
• if updating church-center or proxied apps, update VERSIONS.md to reflect the change/associated PR

🚀📚 Deploying Storybook:

• yarn deploy:storybook
• view changes: https://planningcenter.github.io/doxy-web/

Consumable CSS

• yarn add @planningcenter/doxy-web
• import @planningcenter/doxy-web/dist/css/doxy-web