Skip to content

Stories for Source Academy

jflim98 edited this page Apr 5, 2023 · 1 revision

Description

Stories for Source Academy is a lightweight technical blogging platform with a key focus on interactivity. It is inspired by the notebook interface which allows readers to easily evaluate code snippets within the blog. There is also a built-in editor for authors to easily and quickly write highly interactive technical blogs. Blogs are saved in a specific GitHub repository of the author in Markdown format.

Deployment

Environment Variables

These can be found in the .env config file. Only two environment variables are pertinent to Stories for Source Academy.

STORIES_GITHUB_REPO_NAME

Set STORIES_GITHUB_REPO_NAME to the name of the repository blogs should be saved and loaded from.
If this variable is not set, it will default to placeholder-name.

REACT_APP_STORIES_BACKEND_URL

Set REACT_APP_STORIES_BACKEND_URL to the URL of the stories backend.
This field is optional - the stories backend is not necessary for the hosting and viewing of blogs, only for the aggregation of blogs.

Implementation and Documentation

TBA