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

generator-urca

v1.1.1

Published

Yeoman generator for Javascript or TypeScript libraries

Downloads

3

Readme


Getting started

Before we begin, make sure you have the Yeoman scaffolding toolset installed (yo), since it is part of the Yeoman tool set you might have installed it before. Use npm to globally install yo:

npm install --global yo

If you have permissions problems installing a package globally, use a super user or sudo:

sudo npm install --global yo

Once you have yo installed, you will need to install the urca generator as well:

npm install --global urca

You are now ready to create your library!

How to use

The urca generator will help you create a JavaScript or TypeScript application in your working directory. To create your library project, navigate to a new project folder and then use yo to generate your application:

yo urca

The generator will ask you a few questions and will generate it for you.

Questions the generator will ask

  • app name
  • app description
  • app keywords
  • public or private repository
  • JavaScript or TypeScript
  • add or not React to demo page
  • GitHub username
  • GitHub email
  • first and last name
  • dependencies:

Directory structure

When the installation process is over, this is the file structure that will be generated:

.
├── demo/              # demo page
│   └── index.html
│   └── index.j(t)s(x)
│   └── style.css
├── dist/              # distributable version of app built using Parcel
├── node_modules/      # npm managed libraries
├── src/               # project source code
│   └── lib/           # folder for your library
│      └── hello.j(t)s
│   └── index.j(t)s    # app entry point
├── .eslintrc.js
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── .yo-rc.json
├── LICENSE
├── package.json
├── README.md
├── (tsconfig.json)
├── yarn.lock

Features

  • Prettier to format your code
  • Eslint to lint your code
  • Parcel to automagically compile ES6
  • TypeScript
  • React to simplify the demo page development
  • Git initialization
  • README
  • MIT license

Scripts

Once you have created the structure of your new app, these are the prompt commands you can run:

  • yarn start:demo: to preview and watch for demo page changes (http://localhost:1234)
  • yarn build: to build your webapp for production in /dist

Issues & contributing

This project is still in progress. Anyway, if you open an issue (or a PR), I will be happy :)

Todo

  • [ ] Jest because testing matters
  • [ ] React
    • [ ] to lib
    • [x] to demo page

License

MIT © Ilaria Venturini