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

@cfpb/rental-assistance-finder

v0.6.0

Published

This tool allows users to view and filter emergency rental assistance programs funded by the U.S. Department of Treasury’s Emergency Rental Assistance Program.

Downloads

39

Readme

Rental assistance finder tool

This tool allows users to view and filter emergency rental assistance programs funded by the U.S. Department of Treasury’s Emergency Rental Assistance Program.

React app

This tool is developed and maintained as a standalone React app. The app is then built, and the final, compiled Javascript and CSS files are used by our site. These compiled files can be found in the dist directory.

By distributing both the React source code and the final built Javascript and CSS files, we hope this package can be useful to more developers, as well as opening up our process for developing and publishing this application.

To run locally as a React component

  1. Clone repo

  2. Run yarn

  3. Run yarn start

    This runs the app in the development mode.

    Open http://localhost:3000 to view it in the browser. The page will reload if you make edits.

Testing

All linting and testing can be run with yarn run test. Otherwise, the individual checks can be done below:

Linting

  • Lint the application with yarn run lint.
  • Autofix linting issues with yarn run lint --fix

Unit tests

  • Run unit tests with yarn run test:unit.

Functional tests

Ensure a local server is running (with yarn start).

  • Run functional tests with yarn run cypress run.
  • Run functional tests interactively with yarn run cypress open
  • Run component functional tests with yarn run cypress run-ct

To use inside a website

  1. (Optional) Install this package using npm install
  2. Include the main.js and main.css files from the dist/ folder in your HTML page.
  3. Add a container element to the page with id rental-assistance-finder
  4. From here, you may need to further adjust CSS rules to customize the style of the resulting elements.