README
¶
a modern community platform
With a fresh new take on traditional bulletin board web forum software, Storyden is a modern, secure and extensible platform for building communities.
Storyden
Storyden is the platform for managing community and content, wherever they call home. Run a forum, a blog, post news, curate cool sites, build a directory, a knowledgebase and more. Learn more here.
If you'd like to help with some research, please fill in this tiny (anonymous) form: https://airtable.com/shrLY0jDp9CuXPB2X
You can try it right now! Run the image and open http://localhost:8000 in your browser:
docker run -p 8000:8000 ghcr.io/southclaws/storyden
Releases and versions
Storyden releases tagged versions using a simple version number which applies to the product as a whole not the API surface. For this reason, we do not use "semantic versioning" and breaking API changes are avoided as much as possible. Sometimes breaking changes may occur but these will always be documented and called out in release notes as well as in a separate list of just breaking changes.
v1.25.8
│ │ │
│ │ └── Release: increments for every release in the year.
│ └───── Year: releases happen frequently so we use a year marker for simplicity
└─────── Major: will always be 1
This format was chosen for compatibility with package/app registries and developer expectations, but it does not follow semantic versioning, it's more of a "build number" similar to how video games are versioned.
Outside of a release commit/image, version numbers inside files and the API will be suffixed with -post to indicate you're off a stable release.
What can it do
Storyden is a modern forum, wiki and community hub. Like the internet forums of the past, but with a fresh coat of paint and modern security, deployment and intelligence features. A discussion forum, a Notion workspace and your own Reddit platform all rolled into one. Your community can use it for discussion, sharing links or building a directory of knowledge or structured data.
It's open source, super easy to self host and an homage to the 2000s internet!
Why
https://www.storyden.org/blog/building-running-administrating-modern-forum-software
The short version is: most forums are decades old, insecure, abandoned or just not pretty. Storyden aims to solve all of that with a modern language, simple deployment and beautiful design.
Contributing
See LOCAL_DEVELOPMENT.md for local development documenation.
Contributions are very very welcome! ❤️ Until we get a proper guide set up, please open an issue if you have any questions!
Directories
¶
| Path | Synopsis |
|---|---|
|
app
|
|
|
resources/datagraph/hydrate
Package hydrate provides a generic datagraph item lookup conversion.
|
Package hydrate provides a generic datagraph item lookup conversion. |
|
resources/like/item_like
Package item_like defines a Like on an item such as a post.
|
Package item_like defines a Like on an item such as a post. |
|
resources/like/profile_like
Package profile_like defines a Like within the context of a profile.
|
Package profile_like defines a Like within the context of a profile. |
|
resources/mark
Mark represents a flexible identifier which may be formed as a raw XID, an XID and a slug separated by a hyphen, or just a slug on its own.
|
Mark represents a flexible identifier which may be formed as a raw XID, an XID and a slug separated by a hyphen, or just a slug on its own. |
|
services/link/fetcher
package fetcher simply grabs URLs, scrapes them and stores them and assets.
|
package fetcher simply grabs URLs, scrapes them and stores them and assets. |
|
services/reply
Package reply provides APIs for managing posts within a thread.
|
Package reply provides APIs for managing posts within a thread. |
|
services/semdex
Package semdex provides an interface for semantic indexing of the datagraph.
|
Package semdex provides an interface for semantic indexing of the datagraph. |
|
services/thread
Package thread provides APIs for working with threads which are sequences of posts.
|
Package thread provides APIs for working with threads which are sequences of posts. |
|
transports
Package transports contains all the transport layers that facilitate interfacing with the application.
|
Package transports contains all the transport layers that facilitate interfacing with the application. |
|
transports/http
Package http provides a transport layer using HTTP.
|
Package http provides a transport layer using HTTP. |
|
transports/http/bindings
Package bindings is responsible for providing a bridge between the code that is generated from the OpenAPI specification that comprises the "Transport" layer and the code that implements the product, or the "Service" layer.
|
Package bindings is responsible for providing a bridge between the code that is generated from the OpenAPI specification that comprises the "Transport" layer and the code that implements the product, or the "Service" layer. |
|
transports/http/middleware/session_cookie
Package session provides session handling primitives and middleware for the API.
|
Package session provides session handling primitives and middleware for the API. |
|
transports/http/openapi
Package openapi provides primitives to interact with the openapi HTTP API.
|
Package openapi provides primitives to interact with the openapi HTTP API. |
|
cmd
|
|
|
backend
command
|
|
|
clean
command
|
|
|
e2etest
command
|
|
|
largeseed
command
|
|
|
migrate
command
|
|
|
sd
command
|
|
|
sd/internal/batch
Package batch is the per-identifier mutation runner used by node delete, node visibility, node move and node update.
|
Package batch is the per-identifier mutation runner used by node delete, node visibility, node move and node update. |
|
sd/internal/commands/listflags
Package listflags provides a reusable flag set for list-style commands so node list, thread list, and node children share the same surface: --page, --limit, --all, --format, --output.
|
Package listflags provides a reusable flag set for list-style commands so node list, thread list, and node children share the same surface: --page, --limit, --all, --format, --output. |
|
sd/internal/commands/node/open
Package open implements `sd node open <slug>`.
|
Package open implements `sd node open <slug>`. |
|
sd/internal/commands/node/search
Package search implements `sd node search <query>` — a thin wrapper around the datagraph search endpoint, filtered to node items.
|
Package search implements `sd node search <query>` — a thin wrapper around the datagraph search endpoint, filtered to node items. |
|
sd/internal/commands/search
Package search implements `sd search`, a general wrapper around the datagraph search endpoint.
|
Package search implements `sd search`, a general wrapper around the datagraph search endpoint. |
|
sd/internal/filter
Package filter contains client-side predicates that slice node lists by fields the server can't filter on natively (link domain, url contents, presence of a link, parentage, etc.).
|
Package filter contains client-side predicates that slice node lists by fields the server can't filter on natively (link domain, url contents, presence of a link, parentage, etc.). |
|
seed
command
|
|
|
internal
|
|
|
config
Package config contains all environment variable based configuration.
|
Package config contains all environment variable based configuration. |
|
infrastructure
Package infrastructure simply provides all the plumbing packages to the DI.
|
Package infrastructure simply provides all the plumbing packages to the DI. |
|
infrastructure/frontend
Package frontend provides a simple service that executes the Node.js application.
|
Package frontend provides a simple service that executes the Node.js application. |
|
tools/configen
command
|
|
|
tools/eventgen
command
|
|
|
tools/permissiondocgen
command
|
|
|
tools/rbacgen
command
|
|
|
tools/rpcdocgen
command
|
|
|
tools/schemaderef
command
|
|
|
tools/toolbindgen
command
|
|
|
lib
|
|
|
plugins
|
|
|
discord-connector
command
|
|
|
discord-robot-tools
command
|
|
|
openrouter-provider
command
|
|
|
reactbot
command
|
|
|
robot-invoke
command
|
|
|
sdk
|
|
|
examples/simple_go
command
|
|
|
plugin/test_data/crash_boot
command
|
|
|
plugin/test_data/crash_connect
command
|
|
|
plugin/test_data/crash_test
command
|
|
|
plugin/test_data/event_listener
command
|
|
|
plugin/test_data/example
command
|
|