Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.61 KB

readme.md

File metadata and controls

22 lines (16 loc) · 1.61 KB

NoteSelf official page repository

This repository is for the official page of NoteSelf. It has tiddlers and code that automatically builds the brand and online verisons.

Community

If you have doubts or problems please visit our forum!!! https://forum.noteself.org/

Development

This repository has been created as a development environment for NoteSelf. It is not intended for any other usage and should not be used in any other way. It is not a NS server, neither a way to run NoteSelf on your local machine.

Scripts

This repository contains a collection of scripts on the package.json to facilitate the dev workflow. Run any of them just by doing npm run scriptName where scriptName is one scripts contained on package.json. Here is a list of the relevant ones:

  • add-module: asks a bunch of questions and creates a new module using one of the built-in templates. Very useful for bootstrapping new files.
  • tw-dev: spawns a tiddlywiki server using nodemon for hot reloading. Check nodemon.json for config details. It only watches the plugins directory.
  • dev: executes the build pipeline with the plugin directory as target. If you have the dev server running this should trigger a hot reload.
  • clean: Deletes the output directory
  • build: builds the distribution output files. Note that this is only for checking locally that the output files works, the actual build and deploy happens automatically on travis CI. Also note that several plugins are on above locations (pouchdb and tiddlypouch), check the .env file for the required paths. Also note that the folder separator varies from windows to linux/mac