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

retro-ui

v0.0.17

Published

NES-style (8bit-like) react & styled-components UI

Downloads

9

Vulnerabilities

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

Links

Git

Maintainers

sombreroenpuntassombreroenpuntas

Keywords

Readme

retro-ui

license: MIT npm: retro-ui Tests DeepScan grade Maintainability Test Coverage

NES-style (8bit-like) react & styled-components UI

Usage

  1. Install with:
yarn add retro-ui
  1. Add the font via CDN on index.html head:
<!DOCTYPE html>
<html>
  <head>
    <!-- [...] -->
    <link
      rel="stylesheet"
      href="https://fonts.googleapis.com/css?family=Press+Start+2P"
    />
  </head>
  <!-- [...] -->
</html>
  1. Use like:
import React from 'react'
import { Button, ThemeWrapper } from 'retro-ui'

const App = () => (
  <ThemeWrapper>
    <Button>{'Rawr!'}</Button>
  </ThemeWrapper>
)

Detailed docs here

Development

This react library is made with styled-components.
Uses react-styleguidist for docs.

Scripts

yarn        # install deps :)
yarn start  # runs a styleguidist dev server with hot reload
yarn lint   # lint rules
yarn test   # run unit/integration tests

To try out the library from a local build:

yarn build                      # builds for distributing as npm package
cd ../react-test-app            # navigate to a test project
yarn add file:../retro-ui/build # install the library from local version

Local env

Styling and linting rules are enforced on local env. Requires prettier and eslint, as well as editor/IDE integration.
Commit message format is enforced to adhere to conventional commits.
Don't worry, there's feedback from the tools when trying to commit 🤖📟

CI & Releases

  • DeepScan & CodeClimate keep an eye on tech debt and give automated PR reviews
  • On every push (master or PR), CI runs linting and unit/integration tests.
  • On every push to master branch, CI will create a release, build library and docs, and publish to NPM.
  • On every push to master branch, Github pages will publish the website in docs/ folder.

Contribute

Yes please!

TODO

  • Dump all my components from other projects here :)
  • eject crapp
  • Global resets & fonts via styled-components
  • is styleguidist making sense, or switch to storybook?
    • Is it possible to source docs from tests?
  • Write meaningful e2e tests (wdio?)

Big thanks to NES.css

Heavily inspired by NES.css, an awesome NES-style CSS Framework 💖🎮🌟