https://github.com/xiphoseer/padington-client
Client for a collaborative editor
https://github.com/xiphoseer/padington-client
collaborative-editor javascript prosemirror rollup rollup-plugin-scss
Last synced: 6 months ago
JSON representation
Client for a collaborative editor
- Host: GitHub
- URL: https://github.com/xiphoseer/padington-client
- Owner: Xiphoseer
- License: mit
- Created: 2020-05-25T14:56:30.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-05-24T14:25:15.000Z (almost 5 years ago)
- Last Synced: 2025-02-01T03:26:20.334Z (about 1 year ago)
- Topics: collaborative-editor, javascript, prosemirror, rollup, rollup-plugin-scss
- Language: JavaScript
- Homepage:
- Size: 1.05 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# padington-client
This repo contains a prototype for a collaborative editing client based on [ProseMirror](https://prosemirror.net/). The repository was derived from the [rollup-starter-app](https://github.com/rollup/rollup-starter-app) template.
## Getting started
Clone this repository and install its dependencies:
```bash
git clone https://github.com/xiphoseer/padington-client
cd padington-client
npm install
# or
npx degit "xiphoseer/padington-client" my-app
cd my-app
npm install
```
The `public/index.html` file contains a `` tag, which means we need to create `public/bundle.js`. The `rollup.config.js` file tells Rollup how to create this bundle, starting with `src/main.js` and including all its dependencies, including [date-fns](https://date-fns.org).
`npm run build` builds the application to `public/bundle.js`, along with a sourcemap file for debugging.
`npm start` launches a server, using [serve](https://github.com/zeit/serve). Navigate to [localhost:5000](http://localhost:5000).
`npm run watch` will continually rebuild the application as your source files change.
`npm run dev` will run `npm start` and `npm run watch` in parallel.
## License
TBD, likely MPL-2.0