Skip to content

docs-plus/docs.plus

Repository files navigation

Generic badge MIT license Open Source? Yes! PRs Welcome All Contributors Slack Status

πŸ“š Docs.plus

Docs.plus is a real-time collaborative tools to help communites share knowledge

About

It is the result of over six years of research by newspeak.house into civil society and public sector coordination and crisis response. It solves many common organising problems, and can be frictionlessly adopted by all typical stakeholders without needing any training.

Docs.plus intuitively combines all the common communication tools:

  • βœ”οΈ Collaborative documents
  • βœ”οΈ Videocalls (with unlimited self-organising breakout rooms)
  • βœ”οΈ Group text chat
  • 🚧 Profiling
  • ⏭️ Email subscription
  • ⏭️ Search, filtering and tagging
  • ⏭️ Mobile and desktop app
  • ⏭️ Push notifications
  • Suggest the next feature...

Base

Docs.plus is built on Etherpad which is a real-time collaborative editor for the web, our team tweek a etherpad bases for the goal we persude, also we are using combanation of etherpad plugin and custom one to power up our goals.

Plugins

πŸš€ Prerequisites & Installation

Prerequisites and installation are the same as Etherpad flow, follow this link, or you can follow short steps like the following:

# clone the project
git clone https://github.com/nwspk/docs.plus.git

# move to the project folder
cd docsplus

# install pre requirement plugins
npm install --no-save --legacy-peer-deps
        ep_adminpads2
        ep_remove_embed
        ep_hide_line_numbers
        ep_monetization
        https://github.com/samirsayyad/ep_custom_header_message
        https://github.com/samirsayyad/ep_bottom_chat_bar
        https://github.com/ether/ep_comments_page
        https://github.com/ether/ep_cursortrace
        https://github.com/samirsayyad/ep_docs_plus_customize#c68bc28
        https://github.com/samirsayyad/ep_full_hyperlinks#ce24888
        https://github.com/samirsayyad/ep_headings2#f88ac17
        https://github.com/samirsayyad/ep_insert_media#35b26c5
        https://github.com/samirsayyad/ep_loading_pad#84a888f
        https://github.com/samirsayyad/ep_profile_modal#eb3bb71
        https://github.com/samirsayyad/ep_set_title_on_pad#b1688b0
        https://github.com/samirsayyad/ep_table_of_contents#326ccfc
        https://github.com/HMarzban/ep_wrtc_heading#1fd4e08
        https://github.com/ether/ep_sticky_attributes.git

# run the docsplus
src/bin/run.sh

For mor info Take a look at CI

If you wanna have your Turn/Stun server for the video chat you can follow this installation for the Coturn server; Link.
By default, the video plugin uses a public Stun server More info

🀝 Contributing

Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request.

✨ Contributors

Thanks goes to these wonderful people (emoji key):


πŸ“†πŸ’Ό edsaperia

πŸ’»πŸš‡ samirsayyad

πŸ’»πŸš‡Hossein

πŸš‡Josh Balfour

πŸ‘‹ Contact

If you have any further questions, please don’t hesitate, you can reach us by the following:

πŸ“ License

This project is licensed under the Apache License v2 License

Support

Docs.plus is free and open source, please help us stay online: