README.md

v0.1.0

A visual node editor for creating stories.

Chatigami is a node-based narrative editor for Chatterbox. It is currently a work-in-progress project very early in development.

Roadmap

Check out the current GitKraken Board to see progress on the project and upcoming features.

Running from source

Install Node.js, clone the repo, then:

$ npm install
$ npm start

npm start

Runs Chatigami in development mode within a local ElectronJS window.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Building from source

npm run dist:win

Package and build a ready for distribution application for Windows.

npm run dist:mac

Package and build a ready for distribution application for macOS.

npm run dist:linux

Package and build a ready for distribution application for Linux.

Other commands

npm run prettify

Formats the project's code using Prettier with the .prettierrc.yaml config.
It's important to use this before you make any pull requests.

npm run test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
There are currently no tests set up for the project.

Credits

• electron-builder-typescript - The CRA template used in this project.

License

Licensed under the MIT license.