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

oryx

v1.0.3

Published

A convenient API scaffolding framework for Node.js and Express

Downloads

242

Readme

Oryx is a convenient API scaffolding framework for Node.js and Express, taking away the pains of constructing an API without opting for a full-fledged framework such as Angular. The idea behind Oryx is to make it possible to get an app up-and-running very quickly with little effort. Due to Oryx being built on Express, it's a reliable tool to use in any Node.js application.

Compatibility

Oryx is currently tested against Node.js 0.10.x, 0.12.x and 4.x. Even though 0.8.x is not in the CI loops, it should still be supported at the present time.

All commits are sent to TravisCI for testing, and then on to Code Climate for analysis.

Setup

Oryx lives on npm, so just install it via the command line and you're good to go. All other dependencies will be pulled automatically.

Note: Oryx does not depend on Express - this is to allow the user to decide on the version to use.

$ npm install --save oryx

Getting Started

Let's take a look at how easy it is to build a simple app using the Oryx defaults:

var express = require('express');
var Oryx = require('oryx');

var app = express();
var oryx = new Oryx(app);

oryx.autowire(function (err, models, apis){
    if(err){
        throw err;
    }
    
    console.log('Generated models: ' + JSON.stringify(models));
    console.log('Generated APIs: ' + JSON.stringify(apis));
            
    app.listen(3000);
});

That's it.

For more information on how this works, the options which can be provided to Oryx, or any other features, visit the documentation.

Contributing

If you want to contribute to Oryx, please file an issue before filing a PR - I wouldn't want anyone to spend time on a PR which might not be merged. This project is a personal project (at the moment), and so there is no real roadmap with regards to features at this time.

All PRs should pass grunt lint and maintain 100% test coverage. If something isn't covered by lint, please just use the existing code as an example of the style which should be used.

Testing

Tests are run using grunt or npm, and written using Mocha. I aim to maintain 100% coverage where possible (both line and branch).

Tests can be run as follows:

$ npm test
$ grunt test
$ grunt # runs the default Travis loop

Issues

If you spot any issues when using Oryx, please file an issue. Oryx can't get better otherwise!