{"id":13556252,"url":"https://github.com/nim-lang/nimforum","last_synced_at":"2025-05-15T02:05:05.940Z","repository":{"id":3196750,"uuid":"4229888","full_name":"nim-lang/nimforum","owner":"nim-lang","description":"Lightweight alternative to Discourse written in Nim","archived":false,"fork":false,"pushed_at":"2025-04-22T11:24:42.000Z","size":1336,"stargazers_count":766,"open_issues_count":128,"forks_count":69,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-05-07T14:15:53.864Z","etag":null,"topics":["forum","jester","karax-framework","nim","sqlite"],"latest_commit_sha":null,"homepage":"https://forum.nim-lang.org/","language":"Nim","has_issues":true,"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/nim-lang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","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":"2012-05-04T22:52:25.000Z","updated_at":"2025-04-23T07:18:46.000Z","dependencies_parsed_at":"2024-11-04T05:31:13.525Z","dependency_job_id":"b1cefb98-220c-4b6f-b45f-53caa94c5592","html_url":"https://github.com/nim-lang/nimforum","commit_stats":{"total_commits":587,"total_committers":45,"mean_commits":"13.044444444444444","dds":0.5638841567291312,"last_synced_commit":"79755ec81978326fc396c559e7a0ffd1e0f2cef6"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nim-lang%2Fnimforum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nim-lang%2Fnimforum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nim-lang%2Fnimforum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nim-lang%2Fnimforum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nim-lang","download_url":"https://codeload.github.com/nim-lang/nimforum/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254259369,"owners_count":22040819,"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":["forum","jester","karax-framework","nim","sqlite"],"created_at":"2024-08-01T12:03:43.515Z","updated_at":"2025-05-15T02:05:05.867Z","avatar_url":"https://github.com/nim-lang.png","language":"Nim","funding_links":[],"categories":["Nim","nim"],"sub_categories":["Karax"],"readme":"# nimforum\n\nNimForum is a light-weight forum implementation\nwith many similarities to Discourse. It is implemented in\nthe [Nim](https://nim-lang.org) programming\nlanguage and uses SQLite for its database.\n\n## Examples in the wild\n\n[![forum.nim-lang.org](https://i.imgur.com/hdIF5Az.png)](https://forum.nim-lang.org)\n\n\u003cp align=\"center\" margin=\"0\"\u003e\u003ca href=\"https://forum.nim-lang.org\"\u003e\u003cb\u003eforum.nim-lang.org\u003c/b\u003e\u003c/a\u003e\u003c/p\u003e\n\n## Features\n\n* Efficient, type safe and clean **single-page application** developed using the\n  [Karax](https://github.com/pragmagic/karax) and\n  [Jester](https://github.com/dom96/jester) frameworks.\n* **Utilizes SQLite** making set up much easier.\n* Endlessly **customizable** using SASS.\n* Spam blocking via new user sandboxing with great tools for moderators.\n* reStructuredText enriched by Markdown to make formatting your posts a breeze.\n* Search powered by SQLite's full-text search.\n* Context-aware replies.\n* Last visit tracking.\n* Gravatar support.\n* And much more!\n\n## Setup\n\n[See this document.](https://github.com/nim-lang/nimforum/blob/master/setup.md)\n\n## Dependencies\n\nThe following lists the dependencies which you may need to install manually\nin order to get NimForum running, compiled*, or tested†.\n\n* libsass\n* SQLite\n* pcre\n* Nim (and the Nimble package manager)*\n* [geckodriver](https://github.com/mozilla/geckodriver)†\n  * Firefox†\n\n[*] Build time dependencies\n\n[†] Test time dependencies\n\n## Development\n\nCheck out the tasks defined by this project's ``nimforum.nimble`` file by\nrunning ``nimble tasks``, as of writing they are:\n\n```\nbackend              Compiles and runs the forum backend\nrunbackend           Runs the forum backend\nfrontend             Builds the necessary JS frontend (with CSS)\nminify               Minifies the JS using Google's closure compiler\ntestdb               Creates a test DB (with admin account!)\ndevdb                Creates a test DB (with admin account!)\nblankdb              Creates a blank DB\ntest                 Runs tester\nfasttest             Runs tester without recompiling backend\n```\n\nTo get up and running:\n\n```bash\ngit clone https://github.com/nim-lang/nimforum\ncd nimforum\ngit submodule update --init --recursive\n\n# Setup the db with user: admin, pass: admin and some other users\nnimble devdb\n\n# Run this again if frontend code changes\nnimble frontend\n\n# Will start a server at localhost:5000\n# MacOS users should note that port 5000 is reserved for AirPlay\n# Set the entry \"port\" in forum.json to change the default\nnimble backend\n```\n\nDevelopment typically involves running `nimble devdb` which sets up the\ndatabase for development and testing, then `nimble backend`\nwhich compiles and runs the forum's backend, and `nimble frontend`\nseparately to build the frontend. When making changes to the frontend it\nshould be enough to simply run `nimble frontend` again to rebuild. This command\nwill also build the SASS ``nimforum.scss`` file in the `public/css` directory.\n\n### With docker\n\nYou can easily launch site on localhost if you have `docker` and `docker-compose`.\nYou don't have to setup dependencies (libsass, sglite, pcre, etc...) on you host PC.\n\nTo get up and running:\n\n```bash\ncd docker\ndocker-compose build\ndocker-compose up\n```\n\nAnd you can access local NimForum site.\nOpen http://localhost:5000 .\n\n# Troubleshooting\n\nYou might have to run `nimble install karax@#5f21dcd`, if setup fails\nwith:\n\n```\nandinus@circinus ~/projects/forks/nimforum\u003e nimble --verbose devdb\n[...]\n Installing karax@#5f21dcd\n       Tip: 24 messages have been suppressed, use --verbose to show them.\n     Error: No binaries built, did you specify a valid binary name?\n[...]\n     Error: Exception raised during nimble script execution\n```\n\nThe hash needs to be replaced with the one specified in output.\n\n# Copyright\n\nCopyright (c) 2012-2018 Andreas Rumpf, Dominik Picheta.\n\nAll rights reserved.\n\n# License\n\nNimForum is licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnim-lang%2Fnimforum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnim-lang%2Fnimforum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnim-lang%2Fnimforum/lists"}