Substance is a web-based technology stack for collaborative document manipulation. Substance releases all building blocks as Open Source under an MIT license, so you can glue them together for your usecase.
We've prepared a sandbox where you can play around with our editor and run the tests. It's meant to be a starting point for creating your very-own Substance application.
Installation is easy:
-
Install the Substance Screwdriver command line utility.
$ git clone https://github.com/substance/screwdriver.git $ cd screwdriver $ sudo python setup.py install -
Clone the repository
$ git clone https://github.com/substance/substance.git
-
Run the update command, which pulls in all required dependencies
$ cd substance $ substance --update -
Finally start the server and point your browser to
http://localhost:3000$ substance
Currently the following modules are available:
- Substance.Data - A uniform interface to domain data that supports versioning, persistence and replication
- Substance.Document - A feature-rich and well-tested document model and manipulation API
- Substance.Surface - A boilerplate for web-based text editors
- Substance.Chronicle - A git inspired versioning API based on Operational Transformations (OT)
- Substance.Operator - Operational Transformation for strings, arrays and objects.
- Substance.Library - Filing Substance documents
- Substance.Store - Document storage layer