cnpmjs.org
Version:
Private npm registry and web for Enterprise, base on MySQL and Simple Store Service
141 lines (103 loc) • 4.43 kB
Markdown
# cnpmjs.org: Private npm registry and web for Company
So `cnpm` is meaning: **Company npm**.
## Registry
* Our public registry: [r.cnpmjs.org](http://r.cnpmjs.org), syncing from [registry.npmjs.org](http://registry.npmjs.org)
* Current [cnpmjs.org](/) version: <span id="app-version"></span>
* Mirror of [Node.js Manual & Documentation](/dist/latest/docs/api/index.html)
* Mirror of [nodejs.org/dist](http://nodejs.org/dist): [/dist mirror](/dist)
* Mirror of [phantomjs downloads](https://bitbucket.org/ariya/phantomjs/downloads): [phantomjs mirror](/dist/phantomjs/)
<table class="downloads">
<tbody>
<tr>
<td class="count" id="total-packages"></td><td>total packages</td>
<td class="count" id="total-versions"></td><td>total package versions</td>
<td class="count" id="total-deletes"></td><td>total delete packages</td>
</tr>
<tr>
<td class="count"></td><td> downloads today</td>
<td class="count"></td><td> downloads in this week</td>
<td class="count"></td><td> downloads in this month</td>
</tr>
<tr>
<td class="count"></td><td> downloads in the last day</td>
<td class="count"></td><td> downloads in the last week</td>
<td class="count"></td><td> downloads in the last month</td>
</tr>
</tbody>
</table>
<div class="sync" style="display:none;">
<h3>Sync Status</h3>
<p id="sync-model"></p>
<p>Last sync time is <span id="last-sync-time"></span>. </p>
<p class="syncing alert alert-info">The sync worker is working in the backend now. </p>
<table class="sync-status">
<tbody>
<tr>
<td><span id="need-sync"></span> packages need to be sync</td>
<td class="syncing"><span id="left-sync"></span> packages and dependencies waiting for sync</td>
<td><span id="percent-sync"></span>% progress</td>
</tr>
<tr>
<td><span id="success-sync"></span> packages and dependencies sync successed</td>
<td><span id="fail-sync"></span> packages and dependencies sync failed</td>
<td>last success: <span id="last-success-name"></span></td>
</tr>
</tbody>
</table>
</div>
Running on [Node.js](http://nodejs.org), version <span id="node-version"></span>.
<script src="/js/readme.js"></script>
## Version Badge
Default style is `flat-square`.
Badge URL: `http://cnpmjs.org/badge/v/cnpmjs.org.svg` 
* `<0.1.0 & >=0.0.0`: 
* `<1.0.0 & >=0.1.0`: 
* `>=1.0.0`: 
## Usage
use our npm client [cnpm](https://github.com/cnpm/cnpm)(More suitable with cnpmjs.org and gzip support), you can get our client through npm:
```
npm install -g cnpm --registry=http://r.cnpmjs.org
```
Or you can alias NPM to use it:
```bash
alias cnpm="npm --registry=http://r.cnpmjs.org \
--cache=$HOME/.npm/.cache/cnpm \
--disturl=http://cnpmjs.org/dist \
--userconfig=$HOME/.cnpmrc"
#Or alias it in .bashrc or .zshrc
$ echo '\n#alias for cnpm\nalias cnpm="npm --registry=http://r.cnpmjs.org \
--cache=$HOME/.npm/.cache/cnpm \
--disturl=http://cnpmjs.org/dist \
--userconfig=$HOME/.cnpmrc"' >> ~/.zshrc && source ~/.zshrc
```
### install
Install package from [r.cnpmjs.org](http://r.cnpmjs.org). When installing a package or version does not exist, it will try to install from the official registry([registry.npmjs.org](http://registry.npmjs.org)), and sync this package to cnpm in the backend.
```
$ cnpm install [name]
```
### sync
Only `cnpm` cli has this command. Meaning sync package from source npm.
```bash
$ cnpm sync connect
```
sync package on web: [cnpmjs.org/sync/connect](http://cnpmjs.org/sync/connect)
```bash
$ open http://cnpmjs.org/sync/connect
```
### publish / unpublish
Only `admin` user can publish / unpublish package to private registry.
```bash
$ cnpm publish [name]
$ cnpm unpublish [name]
```
### Other commands
Support all the other npm commands. e.g.:
```bash
$ cnpm info cnpm
```
## TODO list
@see Github [Issues](https://github.com/cnpm/cnpmjs.org/issues)
## Histories
Release [History](/history).
## npm and cnpm relation
