npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@planningcenter/doxy-web

v2.7.2

Published

Doxy for Church Center Web

Downloads

4,171

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

kylemellanderkylemellanderjonsuhjonsuhkeolakeolatimmorgantimmorgandanottdanott

Keywords

Readme

doxy-web

Unified styles + React components for Church Center Web.

Links

Getting Started

cd Code
git clone [email protected]:planningcenter/doxy-web.git
cd doxy-web
yarn install

Development Scripts

  • yarn start - compiles SCSS/JS + runs Storybook using localhost
  • yarn develop - compiles SCSS/JS + watches src directory for changes
  • yarn develop:yalc - compiles/watches SCSS/JS and locally publishes bundled code via yalc (this is the preferred way to test package changes locally in church-center or proxied app - (check out the yalc development guide for more details)
  • yarn test - runs defined component tests using Jest
  • yarn test:watch - runs tests + watches src directory for changes

Local Development Process:

  1. Run yarn start to use Storybook development environment
  1. In separate terminal, run yarn develop:yalc to watch src for changes and push to yalc registry
  2. In church-center (or proxied app), run yalc add @planningcenter/doxy-web to consume/test local changes

"Sandbox" Development Environment

The sandbox provides another local testing/development environment where multiple UI elements/components can be viewed simultaneously. This is especially useful for making new CSS changes because you can see multiple instances of the UI states vs. in Storybook, where you can only toggle 1 state at a time.

  1. Run yarn sandbox (parallel command for yarn develop:yalc & cd sandbox && yarn start)
  2. Follow localhost link in terminal to view local Parcel app

To add new views

  1. Add a contextually-named component to sandbox/src/pages directory and export from pages/index.js
  2. Import page/component to src/App.jsx and add to <Router /> with path
  3. Add corresponding <Link /> to src/components/Sidebar.jsx

Contributing

  • New versions to @planningcenter/doxy-web are made using a "batched" process by deploying changes to NPM from main.
  • All changes should be made using a "feature branch" forked from main and merged using our standard PR process.
  • Changes should be documented in the CHANGELOG before merging the approved PR.

Pre-release Versions

See How we pre-release on Notion for detailed instructions/exampled.

Versioning + Deploying to NPM

Refer to the Planning Center release strategy on Notion.

Deploying Storybook:

Consumable CSS

Import @planningcenter/doxy-web/dist/css/doxy-web

Importing React Components

import { Heading } from "@planningcenter/doxy-web"