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

zally-web-ui

v0.1.1

Published

Zally API Linter Web UI

Downloads

17

Readme

dependencies Status codecov

Zally WEB-UI

Zally Web-UI project provides a web user interface to lint your api specs.

Requirements

  • NodeJS >= 7.6

Install

npm install zally-web-ui --save

Usage

Basic

const app = require('zally-web-ui')();

app.listen(3000, () => {
  console.log('zally-web-ui running at http://localhost:3000');
});

Mount to an existing application

const app = require('express')()
const zally = require('zally-web-ui')(/*options*/);

app.use('/api-linter', zally);
app.listen(3000, () => {
  console.log('server running at http://localhost:3000');
});

Configuration options

When instantiating the app you can pass an options object to customize the behavior.

const options = { /* ..my options.. */}
const zally = require('zally-web-ui')(options);

Options

  • windowEnv: the windowEnv object contains all the values exposed to the client on window.env
  • windowEnv.OAUTH_ENABLED (default: false): enable OAuth or just Auth support on the client side (an http call will be fired on /auth/me endpoint to get the current logged in user, if any)
  • windowEnv.ZALLY_API_URL (default: http://localhost:8080): URL pointing to Zally REST API
  • windowEnv.DEBUG (default: true): logs debugging message on the client side
  • logger (default: console): custom logger
  • handlers: the handlers object contains all route handlers used by zally-web-ui
  • handlers.assets: handler that serve static assets
  • handlers.windowEnv: handler that serve /env.js javascript file used to expose windowEnv values to the client on window.env
  • handlers.index: handler that serve the single page application entrypoint on the wild card * to allow HTML5 History API working as expected

Development

Install, build and run in development mode

cd web-ui
npm install
npm run dev

The npm run dev task starts the application server in development mode with nodemon and webpack-dev-server watching for changes. The application server acts as a proxy to webpack-dev-server as the target.

Run in production mode

npm run build
npm start

Build optimized client javascript bundle

Build webpack bundle minified and source-map file(s).

npm run build

Contributing

People interested contributing to the web-ui project can open issues and related pull requests.

Before opening PRs, be sure the test are running by executing npm test.

Contact

Feel free to contact one the maintainers

License

MIT license with an exception. See license file.