{"id":13553604,"url":"https://github.com/SkewedAspect/tome","last_synced_at":"2025-04-03T05:31:11.975Z","repository":{"id":42353349,"uuid":"161100916","full_name":"SkewedAspect/tome","owner":"SkewedAspect","description":"[Mirror] A simple wiki with a modern ui","archived":false,"fork":false,"pushed_at":"2023-01-23T22:36:41.000Z","size":3786,"stargazers_count":1,"open_issues_count":21,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-12T21:48:44.373Z","etag":null,"topics":["nodejs","sqlite3","wiki","wiki-engine"],"latest_commit_sha":null,"homepage":"https://gitlab.com/skewed-aspect/tome","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SkewedAspect.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}},"created_at":"2018-12-10T01:43:57.000Z","updated_at":"2022-11-23T15:25:24.000Z","dependencies_parsed_at":"2023-02-13T04:15:52.455Z","dependency_job_id":null,"html_url":"https://github.com/SkewedAspect/tome","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkewedAspect%2Ftome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkewedAspect%2Ftome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkewedAspect%2Ftome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkewedAspect%2Ftome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SkewedAspect","download_url":"https://codeload.github.com/SkewedAspect/tome/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246944377,"owners_count":20858773,"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":["nodejs","sqlite3","wiki","wiki-engine"],"created_at":"2024-08-01T12:02:29.300Z","updated_at":"2025-04-03T05:31:11.565Z","avatar_url":"https://github.com/SkewedAspect.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","nodejs"],"sub_categories":[],"readme":"# Tome\n\nA simple, markdown-based wiki, backed by sqlite. It's designed to work for small to medium sized sites, and meet the\nneeds of anything from an individual to a development group. It has a basic, hierarchical page structure and permission\nsystem, where sub-pages inherit from their parent pages.\n\nIn terms of \"size\", Tome should be usable for anything even up to Wikipedia sizes; assuming that your sqlite db file \ndoesn't grow beyond the limits of your filesystem. Practically, however, you'll want to keep the DB down around the \ntens of gigabytes range.\n\nTome's real limitation is concurrent users. By default it's just a single node process, running a single sqlitedb. It \nwould be entirely possible to scale (and even to swap sqlite for any other DB supported by [knex.js][knex] with json \nsupport) and actually handle Wikipedia levels of traffic... but that is not what the goal of the project is. The \ntechnology is all there, and it'd even be straight forward to deploy as such... but there are already solutions that \nfill that need.\n\nTome's core strength is in being lightweight, portable, and trivial to deploy.\n\n## Features\n\nTo see the current list of features and their progress, please check out issue [#1][issue-1].\n\n## Getting Started\n\nThe initial database setup is in `migrations`, just run `npm start` to start the\nserver and kick off the migrations. The database lives at `server/db/tome.db`\nfor now.\n\n## Contributing\n\nContributions are welcome. I ask that you follow the same formatting as the rest of the project. You will need to \nensure all tests pass before I will look at your merge request.\n\n## TODO:\n\nThis is just a rough list of things to do while I get the project going.\n\n* [X] Move over to sqlite for the database\n    * [X] Permissions checks in the db\n* [X] Add Unit Tests for the rest api\n* [X] Switch to bootstrap-vue for the ui\n* [X] Switch to ~~webpack~~parceljs\n* [ ] Use socket.io to inform users when a page they're working on has been edited\n* [ ] Use socket.io to update comments when a new one is posted.\n\n[issue-1]: https://gitlab.com/skewed-aspect/tome/issues/1\n[knex]: https://knexjs.org\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSkewedAspect%2Ftome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSkewedAspect%2Ftome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSkewedAspect%2Ftome/lists"}