{"id":13550304,"url":"https://github.com/docelic/fluence","last_synced_at":"2025-05-05T21:21:48.752Z","repository":{"id":66956518,"uuid":"143451891","full_name":"docelic/fluence","owner":"docelic","description":"WYSIWYG wiki powered by Crystal, markdown, and Git","archived":false,"fork":false,"pushed_at":"2020-05-17T19:01:52.000Z","size":3837,"stargazers_count":49,"open_issues_count":26,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-30T23:51:07.009Z","etag":null,"topics":["crystal-lang","markdown","markdown-editor","media","tables","wiki","wiki-engine","wysiwyg","wysiwyg-editor"],"latest_commit_sha":null,"homepage":"","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docelic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-03T16:49:58.000Z","updated_at":"2024-11-21T00:11:38.000Z","dependencies_parsed_at":"2023-02-28T02:31:23.888Z","dependency_job_id":null,"html_url":"https://github.com/docelic/fluence","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Ffluence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Ffluence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Ffluence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Ffluence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docelic","download_url":"https://codeload.github.com/docelic/fluence/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252577120,"owners_count":21770735,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crystal-lang","markdown","markdown-editor","media","tables","wiki","wiki-engine","wysiwyg","wysiwyg-editor"],"created_at":"2024-08-01T12:01:31.386Z","updated_at":"2025-05-05T21:21:48.703Z","avatar_url":"https://github.com/docelic.png","language":"Crystal","funding_links":[],"categories":["Crystal","Git Powered Wiki","markdown","Official Documentation Translations"],"sub_categories":[],"readme":"**Build status**: [![Build Status](https://travis-ci.com/crystallabs/fluence.svg?branch=master)](https://travis-ci.com/crystallabs/fluence)\n[![Version](https://img.shields.io/github/tag/crystallabs/fluence.svg?maxAge=360)](https://github.com/crystallabs/fluence/releases/latest)\n[![License](https://img.shields.io/github/license/crystallabs/fluence.svg)](https://github.com/crystallabs/fluence/blob/master/LICENSE)\n\n# Fluence 0.6.1\n\nElegant wiki powered by Crystal, with markdown as native format and a WYSIWYG editor.\n\nIt uses file-based storage versioned using Git. Wiki pages are created as files and directories on disk and they can be modified in Fluence or via filesystem directly.\n\nFluence uses latest versions: Bootstrap 4.4.0, jQuery 3.4.1 slim, InscrybMDE 1.11.6.\n\n## Installation and Startup\n\nFluence is implemented in Crystal and you will need a Crystal compiler. Obtain it from https://crystal-lang.org/docs/installation/.\n\nTo download and compile Fluence, do:\n\n```bash\ngit clone https://github.com/crystallabs/fluence\ncd fluence\nshards\nbin/ameba      # Warnings reported here are non-critical\ncrystal spec\nmake           # or 'make release'\n```\n\nThe result of the compilation will be one executable file \u0026mdash; bin/fluence.\n\nRun this file and visit [http://localhost:3000/](http://localhost:3000/) in your browser.\n\nTo configure Fluence, please do so in `config/options.cr`. After changing the options, you need to rebuild Fluence.\n\n## Example\n\nHere is how it currently looks:\n\n![Fluence Wiki Screenshot](https://raw.githubusercontent.com/crystallabs/fluence/master/docs/screenshot.png)\n\n## Maintenance Tips\n\nWhen Fluence starts, by default it will create two subdirectories in the current directory:\n\n1. `data/` (further subdivided into `pages/` and `media/`) for actual Wiki pages and their attached media files\n1. `meta/` for metadata, which currently consists of files `users`, `acl`, `pages`, and `media`\n\nThere are no files or directories required to pre-exist for Fluence to work. Feel free to delete any part of data or metadata as long as you restart Fluence after that.\nFiles `meta/pages` and `meta/media` contain indexes of pages and media content respectively. If you believe their contents have gone out of sync with the actual on-disk state (possibly due to a bug or external modifications to files which Fluence didn't auto-detect and update), delete these files and restart Fluence; the indices will be regenerated from actual on-disk contents.\n\n\n\n## Current State / Usability\n\nThe Fluence Wiki is usable. On-disk format for data won't change so you will be able to upgrade in the future without trouble.\n\nImportant things to have in mind currently:\n\n1. The default permissions scheme (which works and can be configured via both `meta/acls` and GUI) by default makes all registered users automatically be admin, and registrations are always open and don't require any confirmation. Therefore, the initial target for deployment and test of Fluence are small/trusted intranets and teams.\n\nThings we have in mind or are working on are listed in [project issues](https://github.com/crystallabs/fluence/issues). Your comments will help us decide on priorities.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocelic%2Ffluence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocelic%2Ffluence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocelic%2Ffluence/lists"}