jyapayne/nimforum
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Lightweight alternative to Discourse written in Nim https://forum.nim-lang.org/
518 commits 15 branches 1 tag 1.4 MiB
Find a file
Joey Yakimowich-Payne a05667ef78 Add server side checking for user permissions
2018-08-07 21:03:05 +09:00
localhost.local/public Improve default stylesheet. 2018-05-24 16:06:41 +01:00
mockup Moves mockups to mockup folder. 2018-05-21 23:21:05 +01:00
public Add frontend category picker and enable categories in threadlist 2018-08-06 16:22:32 +09:00
src Add server side checking for user permissions 2018-08-07 21:03:05 +09:00
tests Add basic categories test 2018-08-06 17:30:07 +09:00
.gitignore Improves .gitignore and removes outdated forum.json.example file. 2018-05-25 22:57:53 +01:00
.gitmodules Rearranges directories and files. 2018-05-18 20:48:01 +01:00
.travis.yml Update Jester to 0.4.0. 2018-07-19 19:37:46 +01:00
license.txt Add setup file. Fixes #139. 2018-05-27 21:25:08 +01:00
nimforum.nimble Update webdriver commit hash 2018-07-23 19:59:05 +09:00
README.md Update readme with required devdb call 2018-07-06 21:55:34 +09:00
setup.md Improves setup document. 2018-05-27 21:45:08 +01:00

README.md

nimforum

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

forum.nim-lang.org

forum.nim-lang.org

Features

  • 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!

Setup

See this document.

Dependencies

The following lists the dependencies which you may need to install manually in order to get NimForum running, compiled*, or tested†.

  • libsass
  • SQLite
  • pcre
  • Nim (and the Nimble package manager)*
  • geckodriver†
    • Firefox†

[*] Build time dependencies

[†] Test time dependencies

Development

Check out the tasks defined by this project's nimforum.nimble file by running 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

Development typically involves running nimble devdb which sets up the database for development and testing, then nimble backend which compiles and runs the forum's backend, and nimble frontend 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 public/css directory.

Copyright

Copyright (c) 2012-2018 Andreas Rumpf, Dominik Picheta.

All rights reserved.

License

NimForum is licensed under the MIT license.