# sharejs.codemirror.example

> Includes an example JS websocket sharejs server, and a client page that uses codemirror with sharejs.

Latest version **0.0.1** (published 2014-10-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install sharejs.codemirror.example
pnpm add sharejs.codemirror.example
yarn add sharejs.codemirror.example
bun add sharejs.codemirror.example
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2014-10-04 |
| First published | 2014-10-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+5 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Charlie Roberts |
| Maintainers | thecharlie |
| Keywords | sharejs, codemirror |

## Links

- npm: https://www.npmjs.com/package/sharejs.codemirror.example
- Repository: https://github.com/charlieroberts/sharejs.codemirror.example
- Issues: https://github.com/charlieroberts/sharejs.codemirror.example/issues
- npm.io page: https://npm.io/package/sharejs.codemirror.example

## Dependencies (8)

- [ws](https://npm.io/package/ws.md) ~0.4.32
- [share](https://npm.io/package/share.md) ~0.7.3
- [livedb](https://npm.io/package/livedb.md) ~0.4.8
- [connect](https://npm.io/package/connect.md) ~3.2.0
- [optimist](https://npm.io/package/optimist.md) ~0.6.1
- [codemirror](https://npm.io/package/codemirror.md) ~4.6.0
- [serve-static](https://npm.io/package/serve-static.md) ~1.6.3
- [share-codemirror](https://npm.io/package/share-codemirror.md) ~0.0.5

## Recent versions

- 0.0.1 (latest) — 2014-10-04
- 0.0.0 — 2014-10-04

## README

sharejs.codemirror.example
==========================

This repo was created so I would have a working share.js / codemirror example with the following traits:

1. Use Share.js 7.x
2. Use CodeMirror for the text editor
3. Use WebSockets instead of browserchannel for client / server communication. I like browserchannel, 
but I'm using share in a project that already has a huge number of dependencies.
4. Use JavaScript instead of CoffeeScript. I don't know CoffeeScript, although I like the way it looks...

##Installation and Use##

###Server###

Using Git:

1. After cloning the repo, run `npm install` in its top level
2. To launch the server, run `node .` in the top level. You can optionally pass a port to run on with the `-p` argument

Using NPM:

1. Create a directory for the project and `cd` into it
2. Run `npm install share.js.codemirror.example` to install
3. Run `node node_modules/share.js.codemirror.example` to start the server. You can optionally pass a port to run on with the `-p` argument

###Client###

1. Open a browser and launch `127.0.0.1:8007` substituting a port number you passed as an argument when starting the server if needed.
2. Open another tab and launch the same url
3. Type some JavaScript into the codemirror instances. They should be synced.

---
_Source: https://npm.io/package/sharejs.codemirror.example · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._