NimForum is a light-weight forum implementation with many similarities to Discourse. It is implemented in the Nim programming language and uses SQLite for its database.
Examples in the wild
- Efficient, type safe and clean single-page application developed using the Karax and Jester frameworks.
- Utilizes SQLite making set up much easier.
- Endlessly customizable using SASS.
- Spam blocking via new user sandboxing with great tools for moderators.
- reStructuredText enriched by Markdown to make formatting your posts a breeze.
- Search powered by SQLite's full-text search.
- Context-aware replies.
- Last visit tracking.
- Gravatar support.
- And much more!
The following lists the dependencies which you may need to install manually in order to get NimForum running, compiled*, or tested†.
- Nim (and the Nimble package manager)*
[*] Build time dependencies
[†] Test time dependencies
Check out the tasks defined by this project's
nimforum.nimble file by
nimble tasks, as of writing they are:
backend Compiles and runs the forum backend runbackend Runs the forum backend frontend Builds the necessary JS frontend (with CSS) minify Minifies the JS using Google's closure compiler testdb Creates a test DB (with admin account!) devdb Creates a test DB (with admin account!) blankdb Creates a blank DB test Runs tester fasttest Runs tester without recompiling backend
To get up and running:
git clone https://github.com/nim-lang/nimforum cd nimforum git submodule update --init --recursive # Setup the db with user: admin, pass: admin and some other users nimble devdb # Run this again if frontend code changes nimble frontend # Will start a server at localhost:5000 nimble backend
Development typically involves running
nimble devdb which sets up the
database for development and testing, then
which compiles and runs the forum's backend, and
separately to build the frontend. When making changes to the frontend it
should be enough to simply run
nimble frontend again to rebuild. This command
will also build the SASS
nimforum.scss file in the
You can easily launch site on localhost if you have
You don't have to setup dependencies (libsass, sglite, pcre, etc...) on you host PC.
To get up and running:
cd docker docker-compose build docker-compose up
And you can access local NimForum site. Open http://localhost:5000 .
You might have to run
nimble install karax@#5f21dcd, if setup fails
andinus@circinus ~/projects/forks/nimforum> nimble --verbose devdb [...] Installing karax@#5f21dcd Tip: 24 messages have been suppressed, use --verbose to show them. Error: No binaries built, did you specify a valid binary name? [...] Error: Exception raised during nimble script execution
The hash needs to be replaced with the one specified in output.
Copyright (c) 2012-2018 Andreas Rumpf, Dominik Picheta.
All rights reserved.
NimForum is licensed under the MIT license.