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

caviar

v6.0.1

Published

A pluggable and extendable web framework which integrates React, Next and Koa to create your own web application out of the box with even zero configuration

Downloads

87

Readme

caviar

Build Status Coverage

⚠️ This document is out-of-date

A pluggable and extendable skeleton which help to integrate several existing web frameworks to create your own micro frontends out of the box with even zero configuration.

An architectural style where independently deliverable frontend applications are composed into a greater whole

Getting Started

mkdir hello && cd hello
yo generator-caviar
npm run dev

Yeah, we have our first application

File Structure

project/
|-- app
|-- pages
|-- caviar.config
|   |-- .env
|   |-- client.env
|   |-- index.js
|-- package.json
|-- ...

Thinking in caviar


The sections below is for development purpose

Extend caviar for your own business

Config chain

How to write caviar plugins

API Documentation

const {
  Sandbox,
  Server,
  ConfigLoader
} = require('caviar')

new Sandbox(options)

  • options Object
    • cwd path the current working directory
    • port? number server port
    • dev? boolean=false whether is for development purpose
    • serverClassPath? path the file path of the Server class. Defaults to the Server class path of the caviar project.
    • configLoaderClassPath? path the file path of the ConfigLoader class

Creates a new sandbox. Sandbox is design to filter the environment variables.

await sandbox.start(): ChildProcess

Start the sandbox, and it will create a new Server by passing {cwd, port, dev} as options.

new Server(options)

  • options Object
    • cwd
    • port? Number options.port will override config.port of caviar.config.js
    • dev?
    • configLoaderClassPath?

Create a new Server

const server = new Server({
  cwd,
  dev: true
})

await server.ready()
server.listen(8888)

await server.ready(): this

Initialize the server

server.callback(): Function

Returns a callback function suitable for the http.createServer() method to handle a request.

require('http')
.createServer(server.callback())
.listen(8888)

This method must NOT be called before the server is ready (await server.ready())

server.listen(port?): Promise

  • port? number optional server port. If port is specified, it will override options.port.
  • callback? Function

License

MIT