Stencila is a platform for creating, collaborating on, and sharing data driven content. Content that is transparent and reproducible, like RMarkdown and Jupyter Notebooks. Content that can be versioned and composed just like we do with open source software using tools like CRAN and NPM. And above all, content that is accessible to non-coders, like Google Docs and Microsoft Office.
Stencila is still at an early beta stage: there are likely to be missing features, bugs and API changes. But we would
- = ready for production use
- = ready for beta user testing
- = ready for alpha testing; use with caution
- numbers (e.g.
0.31) = planned release
We generally only plan one or two releases ahead. We aim to release every 1-2 months, towards a 1.0 release in early 2018. Checkout the current release milestones.
See the Getting Started page on the wiki.
|Application or package||Ready|
|Stencila for Python||✓|
|Stencila for R||✓|
|Stencila for Node.js||✓|
git clone https://github.com/stencila/stencila.git cd stencila npm install npm run start
And navigate to http://localhost:4000/?archive=kitchen-sink&storage=fs.
You can save your document changes by pressing
Use external contexts during development:
Run the docker image first.
docker run -p 2100:2000 stencila/alpha
Now start the development environment and point
STENCILA_PEERS to the new host.
STENCILA_PEERS=http://localhost:2100 npm start
Most development tasks can be run via
|Install and setup dependencies||
|Run the development server||
|Check code for lint||
|Run tests in the browser||
|Run tests with coverage||
|Run documentation server||
API documentation is at http://stencila.github.io/stencila/. These are published using Github Pages, so to update them after making changes: run
make docs, commit the updates and do a
Builds done on Travis CI are archived at http://builds.stenci.la/stencila/. That site can be useful for user acceptance testing without requiring users to download Stencila Desktop. Just provide test users with a link to a work-in-progress user interface e.g http://builds.stenci.la/stencila/test-deploy-2017-08-13-54a67a6/examples/document/index.html?documentId=01-welcome-to-stencila.