https://github.com/sukima/tw-bookcase

A TiddlyWiki management/proxy server
https://github.com/sukima/tw-bookcase

Last synced: 24 days ago
JSON representation

A TiddlyWiki management/proxy server

• Host: GitHub
• URL: https://github.com/sukima/tw-bookcase
• Owner: sukima
• Created: 2019-04-27T15:00:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T21:39:14.000Z (almost 2 years ago)
• Last Synced: 2024-10-21T21:02:48.170Z (30 days ago)
• Language: JavaScript
• Homepage:
• Size: 99.6 KB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
TW Bookcase
TW Bookcase is a TiddlyWiki management application. It consolidates disparate TiddlyWiki folders on your computer into one management application.
TW Bookcase serves TiddlyWiki instances by proxying them so you can have many instances with only one web sever running.

How to Install


Install Node.js


either from your favourite package manager: typically apt-get install nodejs on Debian/Ubuntu Linux or Termux for Android, or brew install node on a Mac

or directly from http://nodejs.org







Open a command line terminal and type:


npm install -g tw-bookcase

If it fails with an error you may need to re-run the command as an administrator:

sudo npm install -g tw-bookcase (Mac/Linux)





Check TW Bookcase is installed by typing:
tw-bookcase --version



In response, you should see TW Bookcase report its current version (eg ""; you may also see other debugging information reported)

Try it out:




tw-bookcase mynewwiki --init to create a folder for a new wiki that includes server-related components



tw-bookcase mynewwiki --listen to start TW Bookcase

Visit http://127.0.0.1:8088/ in your browser (Note the default port number is 8088)





The -g flag causes TW Bookcase to be installed globally. Without it, TW Bookcase will only be available in the directory where you installed it.
If you are using Debian or Debian-based Linux and you are receiving a node: command not found error though node.js package is installed, you may need to create a symbolic link between nodejs and node. Consult your distro's manual and whereis to correctly create a link. See github issue 1434
Example Debian v8.0: sudo ln -s /usr/bin/nodejs /usr/bin/node

Contributing
Contributions are very welcome. The source is available on GitHub.
Please feel free to offer pull requests or send feedback via issues.

License
Copyright 2019 Devin Weaver
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.