{"id":13657192,"url":"https://github.com/FurqanSoftware/papyrus","last_synced_at":"2025-04-24T01:31:33.382Z","repository":{"id":57524033,"uuid":"50202540","full_name":"FurqanSoftware/papyrus","owner":"FurqanSoftware","description":"A real-time collaborative Markdown editor and document repository with simple organization and project-based management","archived":false,"fork":false,"pushed_at":"2022-12-07T05:29:06.000Z","size":873,"stargazers_count":51,"open_issues_count":0,"forks_count":8,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-08-02T05:06:49.658Z","etag":null,"topics":["go","golang","real-time"],"latest_commit_sha":null,"homepage":"https://gophergala2016-papyrus.herokuapp.com/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FurqanSoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-22T19:23:15.000Z","updated_at":"2024-02-02T03:17:08.000Z","dependencies_parsed_at":"2023-01-24T13:31:43.136Z","dependency_job_id":null,"html_url":"https://github.com/FurqanSoftware/papyrus","commit_stats":null,"previous_names":["gophergala2016/papyrus"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fpapyrus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fpapyrus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fpapyrus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fpapyrus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FurqanSoftware","download_url":"https://codeload.github.com/FurqanSoftware/papyrus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223940869,"owners_count":17228913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","golang","real-time"],"created_at":"2024-08-02T05:00:38.333Z","updated_at":"2024-11-10T10:30:50.929Z","avatar_url":"https://github.com/FurqanSoftware.png","language":"Go","funding_links":[],"categories":["Go (134)"],"sub_categories":[],"readme":"# Papyrus\n\nPapyrus is a real-time collaborative Markdown editor and document repository with simple organization and project-based management. At [Furqan Software](https://furqansoftware.com) we always wanted a simple way to collaborate on Markdown documents and Papyrus is our stab at fulfilling that need.\n\n![Obligatory GIF](http://i.imgur.com/WhQqbFA.gif)\n\nAs of writing this README.md, [GopherGala 2016](http://gophergala.com/)'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.\n\n\u003c!-- ## Demo\n\n[https://gophergala2016-papyrus.herokuapp.com/](https://gophergala2016-papyrus.herokuapp.com/) --\u003e\n\n## Usage\n\nCreate a _GOPATH_ for this project:\n\n```\n$ mkdir -p Papyrus\n$ cd Papyrus\n$ export GOPATH=`pwd`\n```\n\nClone this repository:\n\n```\n$ mkdir -p src/github.com/gophergala2016/papyrus\n$ cd src/github.com/gophergala2016/papyrus\n$ git clone https://github.com/gophergala2016/papyrus.git .\n```\n\nInstall dependencies:\n\n```\n$ go get -v ./...\n```\n\nBuild _papyrusd_ binary:\n\n```\n$ go build ./cmd/papyrusd\n```\n\nSet necessary environment variables (see _env-sample.txt_):\n\n```\n$ export ADDR=:5000\n$ export SECRET=some-long-secret\n$ export BASE=http://localhost:5000\n$ export MONGO_URL=mongodb://localhost/papyrus\n$ export GITHUB_CLIENT_ID=your-github-client-id-here\n$ export GITHUB_CLIENT_SECRET=your-github-client-secret-here\n$ export GOOGLE_CLIENT_ID=your-google-client-id-here\n$ export GOOGLE_CLIENT_SECRET=your-google-client-secret-here\n```\n\nMake sure MongoDB is running and all necessary environment variables are set.\n\nRun _papyrusd_:\n\n```\n./papyrusd\n```\n\nOpen your web browser and navigate to [localhost:5000](http://localhost:5000).\n\n## Acknowledgements\n\n- [CodeMirror](https://codemirror.net/) - One fantastic text editor for the web\n- [Code Commit](http://www.codecommit.com/blog/java/understanding-and-applying-operational-transformation) - For their amazing explanation of operational transformation\n- [OT Explained](http://operational-transformation.github.io/visualization.html) - That visualization!\n- [golab](https://github.com/mb0/lab) - For the insights we got from its code\n\n## License\n\nPapyrus is available under the [BSD (3-Clause) License](http://opensource.org/licenses/BSD-3-Clause).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFurqanSoftware%2Fpapyrus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFurqanSoftware%2Fpapyrus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFurqanSoftware%2Fpapyrus/lists"}