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

@cardstack/boxel

v1.0.54

Published

Cardstack Boxel Design System development app.

Downloads

211

Readme

boxel

The repository provides an Ember Addon allowing usage of the Ember component library for the Boxel Design System.

It consists of several parts:

  1. The Boxel Design System Components and their documentation
  2. Various prototypes using the design system
  3. Miscellaneous components that will eventually be moved

Design system components

All components in /addon/components will be used in whatever apps consume the design system. Each component folder consists of several parts:

  • index.hbs & index.js: The template and javascript for the component
    • Note: Unlike a usual Ember addon, these files are automatically reexported in whatever app consumes the addon. So there is no need to handle that on your own.
  • index.css: The pure CSS styles associated with the component. This file will automatically be added to the consuming app as well
  • usage.hbs & usage.js: A standardized way to document and experiment with the designs of each component. All usage files will automatically show up in the components list in /docs in the dummy app. Utilizes chrislopresto/ember-freestyle
    • Note: These files are automatically stripped out of any production build

Prototypes

The prototypes are there to exercise in context various aspects of the design system.

Miscellaneous Components

There are many components that are specific to a certain prototype or will eventually be moved to other repos, like the main Cardhost app.

Running the dummy app

ember serve

Then browse to http://localhost:4200/

Running tests

To run tests interactively:

ember test --s

(To prevent the interactive tests from launching new windows, use command ember test --s --launch=false , and then visit http://localhost:7357/ on your browser.)

To run tests in the console:

ember test

To run the linter:

yarn lint:hbs

yarn lint:js

To run the linter, along with ember tests in the console:

yarn test

Check package.json file for other testing and linting scripts.

Generator

In addition to the normal suite of ember generators, Boxel has a 'boxel-componentblueprint allowing you to generate a new boxel component (index.gts), a CSS file, a usage.gts, and an intergration test. Run it usingember generate boxel-component your-component-name`.

Thumbnails

Generating multiple image sizes / thumbs from /public/media-registry/covers/:

Kill your ember server if it's running otherwise it'll try to rebuild for every size generated.


brew install imagemagick # if not installed already
cd boxel
node generate-thumbs.js

The thumbs / sizes are intended to be committed to the repo for simplicity of static deployment

Using imgix for dynamic production data makes sense when there is a backend server to sign image urls, but for static deployment pregenerating the images is way more convenient than pre-signing the images as the necessary hooks do not exist in broccoli-asset-rev