umcconnell / cp

A no-datastore, client-side pastebin using LZMA compression.

cp

A no-datastore, client-side pastebin using LZMA compression.

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Initial setup
• Contributing
• Versioning
• Authors
• License
• See also
• Acknowledgments

About

cp is a web editor based on CodeMirror that allows sharing text and code documents. Sharing a document works by compressing it using LZMA and encoding it in base 64 in the link. No data is saved server-side, as the entire document is contained in the link.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need node with npm installed on your machine. You can install it from the official website https://nodejs.org.

Initial setup

Clone the git repository

git clone https://github.com/umcconnell/cp.git
cd cp/

Install dependencies:

npm install

Build the project:

npm run bundle

Run a local webserver, for example using Python3:

python3 -m http.server -d dist/

Happy coding!

Contributing

Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Ulysse McConnell - umcconnell

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

See also

Check out the great paste and the fork nopaste that inspired this project.

Acknowledgments

• codemirror - web editor component (MIT LICENSE)
• esbuild - ESM bundler (MIT LICENSE)
• LZMA-JS JS port of the original 7-Zip LZMA implementation (MIT LICENSE)