Quick Start

Documentation

Quick Start

Our story begins with you, the developer. We believe in amplifying you to build and deploy applications at the speed of light. Our mission is to make development 10-100x easier by significantly reducing unnecessary complexity and focusing on what matters most: your story of data. Let's get started.

Get started

First, install our CLI:

macOS

brew install storyscript/brew/story

Ubuntu 16+

sudo snap install story
Get it from the Snap Store

Snap is available on other Linux OS.

Direct from Python

pip install --user story

Python 3.6 or higher is required, thus on Debian/Ubuntu use pip3. The other installation methods listed are recommended.

Next, login with your GitHub account:

story login

All done! You're all set to create and deploy apps written in Storyscript.

If you're having trouble logging in via GitHub, please reach out to us.

Write your first Story

Let's create your first application, to be able to check out the samples which are bundled.

mkdir first_app && cd first_app
story apps create

Doing so will create story.yml in the current directory. This file contains metadata about your new app.

We have created a few examples that can help you bootstrap your project: Let's start you off with a simple hello world serverless http endpoint:

story write http > http.story && cat http.story
when http server listen method: 'get' path: '/' as request
    request write content: 'Hello world!'

Let's deploy this story:

story deploy
Compiling Stories...
Deploying app competent-nash-82.storyscriptapp.com... |
√ Version 1 of your app has been queued for deployment

Waiting for deployment to complete... |
√ Deployed successfully!
If your story listens to HTTP requests, visit https://competent-nash-82.storyscriptapp.com

✨🍰✨ Congratulations! You have just deployed your first Story!

story deploy will deploy all the stories in your project at once.

See it live!

Check the deployment output. It will indicate where your story was deployed.

Next Checkout our extensive documentation about Storyscript to build powerful applications.

Deploy changes

Ready to redeploy your application? We made it easy and intuitive.

Just run the same deploy command again:

story deploy

✨🍰✨ Your application is now live!

Write your own story.

PASSIONATELY BUILT WITH IN AMSTERDAM

2019. Asyncy, Inc.