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

headrest

v0.1.2

Published

A restful, CORS enabled development server - for clicking around front end Javascript projects.

Downloads

5

Readme

headrest

Build Status

npm install headrest

Provides a RESTful, CORS enabled webserver intended for use when developing rest-backed Javascript apps for the browser. If you want to click around in your app, create/read/update/delete objects, but not fire up an entire backend, that is what this is for.

Assumes you init your JS app with or otherwise set an api root URL from which your models build the correct URL for their resource.

You can set the apiRoot like:

headrest = require('headrest')(apiRoot: '/apis/', dbPath: '/tmp/gruntest.json')
# headrest is an express app
headrest.listen(5001)

Resources

It assumes your resources have paths like:

  • for a list of resources (index), /api/rocks or nested as deep as you like - /api/rocks/ffeedc/sedimentaries and so on.
  • for a single resource, /api/rocks/ffeedc, also nested as far as you want.

Sessions

Implements sessions at /api/session.

  • POST whatever you want to /api/session, you'll get a Cookie.

  • GET /api/session - HTTP 200 means you're logged in, 404 if not.

  • DELETE /api/session - removes your session record and sets your cookie to expire.

Example Gruntfile.coffee


headrest = require('headrest')(apiRoot: '/apis/', dbPath: '/tmp/gruntest.json')


module.exports = (grunt) ->
  grunt.loadNpmTasks('grunt-contrib-connect')

  grunt.registerTask('headrest',
    [
      'connect'
    ]
  )

  grunt.initConfig
    connect:
      headrest:
        options:
          port: 5001
          hostname: "0.0.0.0"
          keepalive: true
          middleware: (connect, options) ->
            [headrest]

grunt headrest

This will start the server on http://0.0.0.0:5001/. From a browser, you can create an object with:


var request = $.ajax({
  url: "http://localhost:5001/apis/rocks",
  dataType: "json",
  crossDomain: true,
  type: 'POST',
  data: {name: "sedimentary"}
})

request.done(function(d) {
  var rock = JSON.parse(d)
  console.log( rock.id )
})

// console output:
// > 7cf28fd544be1b7f55296c45d40538f

var request = $.ajax({
  url: "http://localhost:5001/apis/rocks/7cf28fd544be1b7f55296c45d40538f",
  dataType: "json",
  crossDomain: true,
  type: 'PUT',
  data: {name: "Igneous"}
})

request.done(function(d) {
  console.log('updated')
})

var request = $.ajax({
  url: "http://localhost:5001/apis/rocks/7cf28fd544be1b7f55296c45d40538f",
  dataType: "json",
  crossDomain: true,
  type: 'DELETE'
})

request.done(function(d) {
  console.log('removed')
})

TODO:

  • allow setting of session path.
  • keep each record in a separate file (next major ver, whoadb)

Contributing

Fork and

npm install

npm test

or

cake test:watch

Or if any of this code is wack and you think there's a better way to do it, I definitely want to hear about it, no joke.

That's it!

I yanked this idea from my homie Mark's footrest.py