Skip to content
TenebriePublic

About

Open-source collaborative worldbuilding and writing app

Topics

Resources

Stars

24 stars

Watchers

1 watching

Forks

Repository files navigation

Neverkin Logo

Introduction

Build & Test Deploy

Neverkin is an open-source non-commercial collaborative writing and worldbuilding app for storytellers, DMs, writers and novelists. It's great for planning your D&D sessions, writing fanfiction with your friends, keeping track of your thoughts or just when you need to quickly write something down.

App Screenshot

Features:

  • Interactive mindmap
  • Rich text editing
  • Wiki & character pages
  • Relations through @mentions
  • Real-time collaboration
  • Multi-track timelines
  • Custom calendars

For more information, please refer to the official documentation.

Live Deployments

Architecture

The application is built using the microservice architecture for Docker Swarm. The following diagram illustrates the main moving parts:

Architecture Diagram

Frontend (Styx)

Backend (Rhea & Calliope)

Proxy (Gatekeeper)

Infrastructure

Running the app

The development environment requires Node and Docker to run.

In most cases, the following commands are enough to have the entire environment up and running:

  • npm i
  • npm run dev

The migrations are run automatically via a docker-compose task on environment start-up.

The default admin user is admin@localhost with password q.

Desktop application

You may download the built desktop application from the downloads page on the main website, or from the releases page here.

Self-hosting

Please refer to the self-hosting documentation for detailed information on setting up your own cluster.

Technical support

If you encounter trouble, reach out to the developer through the Discord link you can find on the Feedback page in the application. In case of catastrophic data loss, your work can be recovered. However, you are still encouraged to create your own backups.

A database backup is taken every 6 hours

About

Open-source collaborative worldbuilding and writing app

Topics

Resources

Stars

24 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages