flancast90 / finniky-on-node

FinnikyWiki2 is a serverless wiki software based on Jermolene's TW5. Node now is faster and only reliant on local files.

A Customizable JS Wiki built on Node.js

Welcome to FinnikyWiki, a contained Wiki that can be run locally via Node.js on localhost:3000, and a sort of "mash-up" of @Jermolene's TiddlyWiki5 and @sbrl's PeppermintyWiki. The project is open source under GNU-v3 License, which means anyone can Contribute, Fork, or Copy (please give attribution)!

Built by @flancast90, a bit of Stack Overflow :), and the rest by contributors (like you!), FinnikyWiki is built to be a "revolutionary software," implementing a completely local file structure to power its "pages." Because of this, and the Node.js fs system, Finniky changes are near-instant.

Latest Version:

Getting Started

Finniky can be set-up with just a few simple terminal commands and Node.js NPM installs (if you haven't already). The steps to do so are detailed below:

1. Download Node.js from The Official Node.js Project
   
2. Once Node.js is installed on your system, intall the Finniky Dependencies

npm install express
npm install body-parser

3. Download Finniky-on-Node from this repo, keeping all the files in the same directory
4. start Node.js and boot-up Finniky

cd Finniky-on-Node-Location
node server.js

5. Navigate to localhost:3000, where Finniky should now be visible!

Website

Screenshots:

To-Do:

This is an (ever-growing) list of all my burdens and failures things that I (hope) to add to FinnikyWiki2 in the future:

• Better Revision-History (for example, be able to restore, compare, etc)
• SVG library for quick "click-and-go" messages or infographics
• Page and User list (option for listing all registered users, and for displaying all pages in the wiki, linking back to the correct page)
• Better security. Finniky is in its early stages, and already there are several serious issues. I plan to fix these with AES encryption, as well as improve upon hosting files (trust me, it's hard using only client-side JS & HTML as well as no .htaccess files).
• Add sponsor and star buttons to Wiki homepage (It'll help with college, hopefully!)
• Have an idea? share it with me! [email protected] or open an issue

Contributor How-To:

Contributions are very welcome! All you need to do is create a Pull Request or make a New Issue. I'll do my best to add these after painstaking review and hardship (I swear, they're welcome). Please also make sure to include the code as released under the MIT License (so I can use it!).

License

FinnikyWiki2 on Node.js, its code, and its content, are released under the GNU v.3 License. The full terms can be found in the License file, and are also described pretty well Here.