Skip to content

elrrrrrrr/uncap

Repository files navigation

🍾 Uncap

中文版本 🚀 Live Example

Uncap: A missing UI for npmmirror's online pkg viewer.

screenshot

  • 🏗️ Independently deployable
  • 🛠️ Easy to integrate in project
  • 💪🏻 Powerful file parsing performance
  • 🎯 Any semver expression

Deploy with Vercel

Introduction

npmmirror provides a powerful online preview feature for NPM artifacts. Uncap is the frontend implementation of this feature.

Principles

  1. Use umijs as the frontend framework.
  2. Use monaco-editor for file content preview.
  3. Interface services are provided by cnpmcore , which also supports cross-domain calls by default.
  4. Inspired by ref

Development Guide

# Use your preferred package management tool for dependency installation
$ npm i

# Launch the local development environment
$ npm run dev

# If there is a custom deployment requirement
# you can perform the build and package.
# The build output defaults to the dist directory.

$ npm run build

Roadmap

  • Support for semver expressions
  • Path URL mapping
  • Version and release list
  • Access history page
  • Light theme