• Stars
    star
    744
  • Rank 58,847 (Top 2 %)
  • Language
    Nim
  • License
    MIT License
  • Created about 12 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Lightweight alternative to Discourse written in Nim

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

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
# 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:

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.

More Repositories

1

Nim

Nim is a statically typed compiled systems programming language. It combines successful concepts from mature languages like Python, Ada and Modula. Its design focuses on efficiency, expressiveness, and elegance (in that order of priority).
Nim
16,110
star
2

nimble

Package manager for the Nim programming language.
Nim
1,225
star
3

c2nim

c2nim is a tool to translate Ansi C code to Nim. The output is human-readable Nim code that is meant to be tweaked by hand before and after the translation process.
Nim
489
star
4

packages

List of packages for Nimble
Nim
438
star
5

ui

Beginnings of what might become Nim's official UI library.
Nim
237
star
6

sdl2

Nim wrapper for SDL 2.x
Nim
222
star
7

langserver

The Nim language server implementation (based on nimsuggest)
Nim
177
star
8

nim-mode

An emacs major mode for the Nim programming language
Emacs Lisp
134
star
9

RFCs

A repository for your Nim proposals.
134
star
10

fusion

Fusion is for now an idea about how to grow Nim's ecosystem without the pain points of more traditional approaches.
Nim
129
star
11

NimLime

Super Nim Plugin for Sublime Text 2/3
Nim
128
star
12

redis

Official redis wrapper for Nim.
Nim
126
star
13

bigints

BigInts for Nim
Nim
117
star
14

needed-libraries

This repository contains a list a needed libraries.
111
star
15

website

Code for the official Nim programming language website
HTML
109
star
16

opengl

An OpenGL wrapper for Nim
Nim
106
star
17

atlas

The Atlas Package cloner. It manages an isolated workspace that contains projects and dependencies.
Nim
91
star
18

nim-zmq

Nim ZMQ wrapper
Nim
62
star
19

threading

New atomics, thread primitives, atomic refcounting for --gc:arc/orc.
Nim
60
star
20

csources

The pre-generated C sources of the Nim compiler which aid in bootstrapping. This repository is archived because it's frozen, HEAD of csources can build Nim version 1 and any later version.
C
51
star
21

zip

zip wrapper for Nim
C
50
star
22

vscode-nim

A VS Code plugin for the Nim language
Nim
50
star
23

x11

x11 wrapper for Nim
Nim
47
star
24

iup

iup wrapper for Nim. Used to be part of the stdlib, now a Nimble package.
Nim
46
star
25

nightlies

Separate repository to trigger installer builds.
Shell
41
star
26

nimsuggest

idetools for the nim language
39
star
27

lua

Nim Wrapper to interface with the Lua interpreter
Nim
37
star
28

python

Nim wrapper for the Python 2 programming language
Nim
32
star
29

cairo

Nim Cairo wrapper.
Nim
31
star
30

gtk2

gtk2 wrapper for Nim
Nim
30
star
31

opencl

Low-level OpenCL wrapper for Nim
Nim
23
star
32

virus_checker

A virus checker for nim binaries
Nim
21
star
33

db_connector

Unified db connector in Nim
Nim
17
star
34

tcl

Nim Wrapper for the TCL programming language
Nim
16
star
35

csources_v1

CSources compiled from Nim version 1. Supports more CPU/OS combinations than the older csources repository.
C
15
star
36

niminst

EDIT: now archived, see https://github.com/nim-lang/Nim/issues/15946. niminst is a tool to generate an installer for a Nim program. Currently it can create an installer for Windows as well as installation/deinstallation scripts for UNIX. Some support for Linux' package management systems is also included.
Nim
15
star
37

assets

14
star
38

graphics

Graphics module for Nim. Currently based on SDL v1.2.
Nim
13
star
39

compilerdev

This repository contains a collection of documents about how to change/refactor the Nim compiler in order to make it faster, easier to maintain and have fewer bugs by a superior architecture and design. However, no every idea here will work out.
Nim
12
star
40

sat

A SAT solver written in Nim
Nim
12
star
41

punycode

Implements a representation of Unicode with the limited ASCII character subset in Nim.
Nim
12
star
42

wiki

11
star
43

checksums

Hash algorithms in Nim
Nim
11
star
44

standardjs

Wrappers for standardized JS modules.
Nim
10
star
45

ci_bench

A simple performance dashboard for the Nim language
Nim
10
star
46

smtp

SMTP client implementation, adapted from the Nim standard library
Nim
10
star
47

nimbot

The friendly, slightly sentient, Nim IRC bot.
Nim
10
star
48

pas2nim

pas2nim is a tool to translate Delphi/Pascal wrappers to Nim code.
Nim
10
star
49

mongo

MongoDB wrapper for Nim
Nim
9
star
50

dlls

Prebuilt DLLs and lib*.so files for Nim. Every DLL added here will also have at least a description about how we built it.
9
star
51

cgi

Helper procs for CGI applications in Nim.
Nim
8
star
52

dialogs

This module implements portable dialogs for Nim; the implementation builds on the GTK interface. On Windows, native dialogs are shown instead.
Nim
8
star
53

sdl1

SDL v1.2 wrapper for Nim.
Nim
7
star
54

oldwinapi

Old Win API wrapper for Nim.
Nim
7
star
55

csources_v2

CSources compiled from Nim version 2.
C
7
star
56

edutainment

Tasks related to making Nim more widely known such as video creation.
7
star
57

community_map

6
star
58

htmlparser

Parse a HTML document in Nim
Nim
6
star
59

graveyard

non-deprecated modules that have been removed from the Nim stdlib
Nim
5
star
60

security

Embargoed security issues that will be made public after a fix is made available. Use https://github.com/nim-lang/security/security
5
star
61

testspec

in progress
Nim
5
star
62

basic2d

Deprecated package from stdlib.
Nim
4
star
63

asyncftpclient

FTP client implementation, adapted from the Nim standard library
Nim
4
star
64

backport

backport requests
4
star
65

kickstart

Automated bootstrapping scripts for the Nim programming language compiler.
Shell
4
star
66

aporia-bin

Holds binaries for Aporia (mostly DLLs)
Shell
4
star
67

expat

Expat wrapper for Nim.
Nim
3
star
68

basic3d

Nim
3
star
69

joyent_http_parser

Nim
2
star
70

nim-buildbot

Buildbot Configuration and Script Files for Nim
Python
2
star
71

forum.nim-lang.org

Styles for forum.nim-lang.org. Powered by nimforum.
SCSS
2
star
72

libsvm_legacy

Nim
1
star