Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nim-lang/nimforum
Lightweight alternative to Discourse written in Nim
https://github.com/nim-lang/nimforum
forum jester karax-framework nim sqlite
Last synced: 5 days ago
JSON representation
Lightweight alternative to Discourse written in Nim
- Host: GitHub
- URL: https://github.com/nim-lang/nimforum
- Owner: nim-lang
- License: mit
- Created: 2012-05-04T22:52:25.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T13:24:47.000Z (3 months ago)
- Last Synced: 2024-08-20T15:26:05.203Z (3 months ago)
- Topics: forum, jester, karax-framework, nim, sqlite
- Language: Nim
- Homepage: https://forum.nim-lang.org/
- Size: 1.26 MB
- Stars: 759
- Watchers: 21
- Forks: 69
- Open Issues: 129
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
- awesome-starred - nim-lang/nimforum - Lightweight alternative to Discourse written in Nim (nim)
README
# nimforum
NimForum is a light-weight forum implementation
with many similarities to Discourse. It is implemented in
the [Nim](https://nim-lang.org) programming
language and uses SQLite for its database.
## Examples in the wild
[](https://forum.nim-lang.org)
## Features
* Efficient, type safe and clean **single-page application** developed using the
[Karax](https://github.com/pragmagic/karax) and
[Jester](https://github.com/dom96/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.](https://github.com/nim-lang/nimforum/blob/master/setup.md)
## 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](https://github.com/mozilla/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
```
To get up and running:
```bash
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
# MacOS users should note that port 5000 is reserved for AirPlay
# Set the entry "port" in forum.json to change the default
nimble 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.
### With docker
You can easily launch site on localhost if you have `docker` and `docker-compose`.
You don't have to setup dependencies (libsass, sglite, pcre, etc...) on you host PC.
To get up and running:
```bash
cd docker
docker-compose build
docker-compose up
```
And you can access local NimForum site.
Open http://localhost:5000 .
# Troubleshooting
You might have to run `nimble install karax@#5f21dcd`, if setup fails
with:
```
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
Copyright (c) 2012-2018 Andreas Rumpf, Dominik Picheta.
All rights reserved.
# License
NimForum is licensed under the MIT license.