# README
Papyrus
Papyrus is a real-time collaborative Markdown editor and document repository with simple organization and project-based management. At Furqan Software we always wanted a simple way to collaborate on Markdown documents and Papyrus is our stab at fulfilling that need.
As of writing this README.md, GopherGala 2016's 48 hours is almost up. The core collaborative editing functionality, namely operational transformation and other relevant constructs, have been implemented. The webapp is lacking some functionalities (e.g. removing a member that has been added to a project, deleting a document, etc). At this moment, you can login using a Google or GitHub account, create organizations, create projects, create documents and start editing them collaboratively in real-time.
Usage
Clone this repository:
git clone https://github.com/gophergala2016/papyrus.git .
Build papyrusd binary (after cd
-ing into the directory):
go build ./cmd/papyrusd
Create a .env
file and update it as needed:
cp env-sample.txt .env
Start Papyrus using docker-compose
:
docker-compose up
Open your web browser and navigate to localhost:15000.
Acknowledgements
- CodeMirror - One fantastic text editor for the web
- Code Commit - For their amazing explanation of operational transformation
- OT Explained - That visualization!
- golab - For the insights we got from its code
License
Papyrus is available under the BSD (3-Clause) License.