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-harp

v1.0.1

Published

Scaffold a harp application using EJS and sass

Downloads

2

Readme

Harp Static Site Generator... Generator

Feedback

Help me make this better! If something in generator-harp could be better, or just doesn't work, tell me about it in an issue, or even take a stab at fixing it yourself in a fork and making a pull request. You can do it!

Getting Started

Before you being, you might want to familiarize yourself with harp at http://harpjs.com/. This generator currently creates a harp project using EJS, vanilla Javascript and Sass, but you can also use Markdown, Jade, LESS, Stylus and Coffeescript for preprocessing your project.

You will need to have NPM installed. Get it at http://nodejs.org.

Installing Prerequisites: Node, Gulp and Harp

Once you have node installed, use npm to install all prerequisites

$ npm install -g yo gulp harp

if you get an EACCESS error, run this command with sudo

Install this generator

$ npm install -g generator-harp

if you get an EACCESS error, run this command with sudo

Create your project!

$ mkdir project-name $ cd project-name $ yo harp

Run the application

to run the site locally for development, just use the command $ gulp.

to compile down the static site assets to publish to a service like github pages, use the command $ npm run compile in the project's root directory.

You'll find the compiled site in a folder called dist in the project directory.

Directory Structure

/project-main
  gulpfile.js................... gulp tasks for harp server and build
  harp.json..................... defines the root of the harp project
  package.json.................. defines project dependencies
  /public....................... directory for all public facing assets
    _layout.ejs................. base markup including <head> which will wrap your views
    index.ejs................... index file which will be templated into _layout.ejs
    /css
      main.scss................. the primary manifest and base styles for your sass
      /partials................. this directory is here to contain your sass partials
      /scaffolding.............. some scaffolding and base declarations
        _colors.scss............ a file to define color variables
        _type.scss.............. a file to define type variables
        _scaffolding.scss....... a file in which I've included some flexbox placeholders, breakpoint mixins and more for you to optionally use
    /scripts.................... where you will store your javascript
      ui.js..................... a base, vanilla javscript file with an empty onLoad structure
    /views...................... where you will build individual pages' markup
      /partials................. where you will build reusable ejs partials
    /img........................ where you will store all image assets