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

@cobatech/sunrise

v0.0.4

Published

Sunrise Design System

Downloads

5

Readme

Sunrise


:rocket: Builds Status

Master:

pipeline status

Development:

pipeline status

:nail_care: Test Coverage

Master:

coverage report

Development:

coverage report


:memo: Documentation

Requirements

Stack


Environment Variables

Application variables

Set Application variables in the .env file

  • NODE_ENV
  • ENV
  • DEV (changes the development mode for the use of the library)
  • NPM_TOKEN (token do publish in npm)

Initialization

git clone [email protected]:laborit/sunrise.git
cd sunrise/
cp .env.sample .env
npm i
npm run dev

Build

Build library to production

npm run build

output path /lib

Build client to production

npm run build:dev

output path /dist

Storybook

Use storybook to document library components see more details in storybook documentation

Initialize storybook server

npm run storybook

build storybook static

npm run build-storybook

output path /storybook-static


Testing

Using jest with enzyme and chai (see examples on ./src/**/*.spec.js)

npm test
npm run test:coverage

Linting

Using eslint

npm run lint

Deploy

NPM package

Locally

Logged in at NPM with your user

Build the library

npm run build

Update package version:

npm version major | minor | patch

see more details in npm-version

Publish the package

npm publish --access public

With Gitlab CI

Set the npm token on gitlab ci environment variable NPM_TOKEN

Before commit, update package version:

npm version major | minor | patch

see more details in npm-version

After than, commit to branch master:

git push origin master

Prettier

  • https://prettier.io/ (Supports VSCode, Sublime Text, Vim, Atom and others)

Why?

It removes all original styling and ensures that all outputted code conforms to a consistent style.

As you can see, these two tools we make sure our codebase is consistent across all developers, IDE's and operating systems. Make sure you have them properly configurated on your IDE before starting writing code.

Useful references & links