-_See also: Running the forum for how to create the database_
+## 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 code depends on the RST parser of the Nim
-compiler and on Jester. The code generating captchas for registration uses the
-[cairo module](https://github.com/nim-lang/cairo), which requires you to have
-the [cairo library](http://cairographics.org) installed when you run the forum,
-or you will be greeted by a cryptic error message similar to:
+The following lists the dependencies which you may need to install manually
+in order to get NimForum running, compiled*, or tested†.
- $ ./forum could not load: libcairo.so(1.2)
+* libsass
+* SQLite
+* pcre
+* Nim (and the Nimble package manager)*
+* [geckodriver](https://github.com/mozilla/geckodriver)†
+ * Firefox†
-### Mac OS X
+[*] Build time dependencies
-#### cairo
-If you are using macosx and have installed the ``cairo`` library through
-[MacPorts](https://www.macports.org) you still need to add the library path to
-your ``LD_LIBRARY_PATH`` environment variable. Example:
+[†] Test time dependencies
- $ LD_LIBRARY_PATH=/opt/local/lib/ ./forum
+## Development
-Replace ``/opt/local/lib`` with the correct path on your system.
-
-#### bcrypt
-
-On macosx you also need to make sure to use the bcrypt >= 0.2.1 module if that
-is not yet updated you can install it with:
+Check out the tasks defined by this project's ``nimforum.nimble`` file by
+running ``nimble tasks``, as of writing they are:
```
-nimble install https://github.com/oderwat/bcryptnim.git@#fix-osx
+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
```
-You may also need to change `nimforum.nimble` such that it uses 0.2.1 by
-changing the dependencies slightly.
+To get up and running:
-```
-[Deps]
-Requires: "nimrod >= 0.10.3, cairo#head, jester#head, bcrypt >= 0.2.1"
+```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
+nimble backend
```
-# Running the forum
+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.
-**Important: You need to compile and run `createdb` to generate the initial database
-before you can run `forum` the first time**!
+### With docker
-**Note: If you do not have a mail server set up locally, you can specify
-``-d:dev`` during compilation to prevent nimforum from attempting to send
-emails and to automatically activate user accounts**
+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.
-This is as simple as:
+To get up and running:
-```
-nim c -r createdb
+```bash
+cd docker
+docker-compose build
+docker-compose up
```
-After that you can just run `forum` and if everything is ok you will get the info which URL you need to open in your browser (http://localhost:5000) to access it.
+And you can access local NimForum site.
+Open http://localhost:5000 .
-_There is an update helper `editdb` which you can safely ignore for now._
+# Troubleshooting
-_The files `captchas.nim`, `cache.nim` are included by `forum.nim` and do
-not need to be compiled by you._
+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-2015 Andreas Rumpf, Dominik Picheta.
+Copyright (c) 2012-2018 Andreas Rumpf, Dominik Picheta.
All rights reserved.
# License
-Nimforum is licensed under the MIT license.
+NimForum is licensed under the MIT license.
diff --git a/cache.nim b/cache.nim
deleted file mode 100644
index 6023393..0000000
--- a/cache.nim
+++ /dev/null
@@ -1,32 +0,0 @@
-import tables, uri
-type
- CacheInfo = object
- valid: bool
- value: string
-
- CacheHolder = ref object
- caches: Table[string, CacheInfo]
-
-proc normalizePath(x: string): string =
- let u = parseUri(x)
- result = u.path & (if u.query != "": '?' & u.query else: "")
-
-proc newCacheHolder*(): CacheHolder =
- new result
- result.caches = initTable[string, CacheInfo]()
-
-proc invalidate*(cache: CacheHolder, name: string) =
- cache.caches[name.normalizePath()].valid = false
-
-proc invalidateAll*(cache: CacheHolder) =
- for key, val in mpairs(cache.caches):
- val.valid = false
-
-template get*(cache: CacheHolder, name: string, grabValue: untyped): untyped =
- ## Check to see if the cache contains value for ``name``. If it does and the
- ## cache is valid then doesn't recalculate it but returns the cached version.
- mixin normalizePath
- let nName = name.normalizePath()
- if not (cache.caches.hasKey(nName) and cache.caches[nName].valid):
- cache.caches[nName] = CacheInfo(valid: true, value: grabValue)
- cache.caches[nName].value
diff --git a/captchas.nim b/captchas.nim
deleted file mode 100644
index f569f04..0000000
--- a/captchas.nim
+++ /dev/null
@@ -1,37 +0,0 @@
-#
-#
-# The Nim Forum
-# (c) Copyright 2012 Andreas Rumpf, Dominik Picheta
-# Look at license.txt for more info.
-# All rights reserved.
-#
-
-import cairo, os, strutils, jester
-
-proc getCaptchaFilename*(i: int): string {.inline.} =
- result = "public/captchas/capture_" & $i & ".png"
-
-proc getCaptchaUrl*(req: Request, i: int): string =
- result = req.makeUri("/captchas/capture_" & $i & ".png", absolute = false)
-
-proc createCaptcha*(file, text: string) =
- var surface = imageSurfaceCreate(FORMAT_ARGB32, int32(10*text.len), int32(10))
- var cr = create(surface)
-
- selectFontFace(cr, "serif", FONT_SLANT_NORMAL, FONT_WEIGHT_BOLD)
- setFontSize(cr, 12.0)
-
- setSourceRgb(cr, 1.0, 0.5, 0.0)
- moveTo(cr, 0.0, 10.0)
- showText(cr, repeat('O', text.len))
-
- setSourceRgb(cr, 0.0, 0.0, 1.0)
- moveTo(cr, 0.0, 10.0)
- showText(cr, text)
-
- destroy(cr)
- discard writeToPng(surface, file)
- destroy(surface)
-
-when isMainModule:
- createCaptcha("test.png", "1+33")
diff --git a/createdb.nim b/createdb.nim
deleted file mode 100644
index 4162c36..0000000
--- a/createdb.nim
+++ /dev/null
@@ -1,124 +0,0 @@
-#
-#
-# The Nim Forum
-# (c) Copyright 2012 Andreas Rumpf, Dominik Picheta
-# Look at license.txt for more info.
-# All rights reserved.
-#
-
-import strutils, db_sqlite
-
-var db = open(connection="nimforum.db", user="postgres", password="",
- database="nimforum")
-
-const
- TUserName = "varchar(20)"
- TPassword = "varchar(32)"
- TEmail = "varchar(30)"
-
-db.exec(sql"""
-create table if not exists thread(
- id integer primary key,
- name varchar(100) not null,
- views integer not null,
- modified timestamp not null default (DATETIME('now'))
-);""", [])
-
-db.exec(sql"""
-create unique index if not exists ThreadNameIx on thread (name);
-""", [])
-
-db.exec(sql("""
-create table if not exists person(
- id integer primary key,
- name $# not null,
- password $# not null,
- email $# not null,
- creation timestamp not null default (DATETIME('now')),
- salt varbin(128) not null,
- status varchar(30) not null,
- lastOnline timestamp not null default (DATETIME('now'))
-);""" % [TUserName, TPassword, TEmail]), [])
-# echo "person table already exists"
-
-db.exec(sql("""
-alter table person
-add ban varchar(128) not null default ''
-"""))
-
-db.exec(sql"""
-create unique index if not exists UserNameIx on person (name);
-""", [])
-
-# ----------------------- Forum ------------------------------------------------
-
-
-if not db.tryExec(sql"""
-create table if not exists post(
- id integer primary key,
- author integer not null,
- ip inet not null,
- header varchar(100) not null,
- content varchar(1000) not null,
- thread integer not null,
- creation timestamp not null default (DATETIME('now')),
-
- foreign key (thread) references thread(id),
- foreign key (author) references person(id)
-);""", []):
- echo "post table already exists"
-
-# -------------------- Session -------------------------------------------------
-
-if not db.tryExec(sql("""
-create table if not exists session(
- id integer primary key,
- ip inet not null,
- password $# not null,
- userid integer not null,
- lastModified timestamp not null default (DATETIME('now')),
- foreign key (userid) references person(id)
-);""" % [TPassword]), []):
- echo "session table already exists"
-
-if not db.tryExec(sql"""
-create table if not exists antibot(
- id integer primary key,
- ip inet not null,
- answer varchar(30) not null,
- created timestamp not null default (DATETIME('now'))
-);""", []):
- echo "antibot table already exists"
-
-# -------------------- Search --------------------------------------------------
-
-if not db.tryExec(sql"""
- CREATE VIRTUAL TABLE thread_fts USING fts4 (
- id INTEGER PRIMARY KEY,
- name VARCHAR(100) NOT NULL
- );""", []):
- echo "thread_fts table already exists or fts4 not supported"
-else:
- db.exec(sql"""
- INSERT INTO thread_fts
- SELECT id, name FROM thread;
- """, [])
-if not db.tryExec(sql"""
- CREATE VIRTUAL TABLE post_fts USING fts4 (
- id INTEGER PRIMARY KEY,
- header VARCHAR(100) NOT NULL,
- content VARCHAR(1000) NOT NULL
- );""", []):
- echo "post_fts table already exists or fts4 not supported"
-else:
- db.exec(sql"""
- INSERT INTO post_fts
- SELECT id, header, content FROM post;
- """, [])
-
-
-# ------------------------------------------------------------------------------
-
-#discard stdin.readline()
-
-close(db)
diff --git a/docker/Dockerfile b/docker/Dockerfile
new file mode 100644
index 0000000..cb3191a
--- /dev/null
+++ b/docker/Dockerfile
@@ -0,0 +1,14 @@
+FROM nimlang/nim:1.2.6-ubuntu
+
+RUN apt-get update -yqq \
+ && apt-get install -y --no-install-recommends \
+ libsass-dev \
+ sqlite3 \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+COPY . /app
+
+# install dependencies
+RUN nimble install -Y
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
new file mode 100644
index 0000000..8657235
--- /dev/null
+++ b/docker/docker-compose.yml
@@ -0,0 +1,12 @@
+version: "3.7"
+
+services:
+ forum:
+ build:
+ context: ../
+ dockerfile: ./docker/Dockerfile
+ volumes:
+ - "../:/app"
+ ports:
+ - "5000:5000"
+ entrypoint: "/app/docker/entrypoint.sh"
diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh
new file mode 100755
index 0000000..d8f5923
--- /dev/null
+++ b/docker/entrypoint.sh
@@ -0,0 +1,19 @@
+#!/bin/sh
+
+set -eu
+
+git submodule update --init --recursive
+
+# setup
+nimble c -d:release src/setup_nimforum.nim
+./src/setup_nimforum --dev
+
+# build frontend
+nimble c -r src/buildcss
+nimble js -d:release src/frontend/forum.nim
+mkdir -p public/js
+cp src/frontend/forum.js public/js/forum.js
+
+# build backend
+nimble c src/forum.nim
+./src/forum
diff --git a/editdb.nim b/editdb.nim
deleted file mode 100644
index e12f679..0000000
--- a/editdb.nim
+++ /dev/null
@@ -1,13 +0,0 @@
-
-import strutils, db_sqlite, ranks
-
-var db = open(connection="nimforum.db", user="postgres", password="",
- database="nimforum")
-
-db.exec(sql("update person set status = ?"), $User)
-db.exec(sql("update person set status = ? where ban <> ''"), $Troll)
-db.exec(sql("update person set status = ? where ban like '%spam%'"), $Spammer)
-db.exec(sql("update person set status = ? where ban = 'DEACTIVATED' or ban = 'EMAILCONFIRMATION'"), $EmailUnconfirmed)
-db.exec(sql("update person set status = ? where admin = 'true'"), $Admin)
-
-close(db)
diff --git a/forms.tmpl b/forms.tmpl
deleted file mode 100644
index 9d62d95..0000000
--- a/forms.tmpl
+++ /dev/null
@@ -1,514 +0,0 @@
-#? stdtmpl | standard
-#
-#template `%`(idx: untyped): untyped =
-# row[idx]
-#end template
-#
-#
-#proc genThreadsList(c: var TForumData, count: var int): string =
-# const queryModAdmin = sql"""select id, name, views, modified from thread
-# where id in (select thread from post where author in
-# (select id from person where status not in ('Spammer') or id = ?))
-# order by modified desc limit ?, ?"""
-# const query = sql"""select id, name, views, modified from thread
-# where id in (select thread from post where author in
-# (select id from person where status not in ('Moderated', 'Spammer') or id = ?))
-# order by modified desc limit ?, ?"""
-# const threadId = 0
-# const name = 1
-# const views = 2
-#
-# result = ""
-# count = 0
-
-
- #let users = getAllRows(db,
- # sql("select distinct name, email from person where id in " &
- # "(select author from post where thread = ?)"), %threadId)
-
-
- #for i in 0 .. min(6, users.len-1):
-
- #end for
-
-
-
- #let latestReplyAuthor = getValue(db, sql("select name from person where id = " &
- # "(select author from post where id = " &
- # "(select max(id) from post where thread = ?))"), %threadId)
-
- #let replyProfileUrl = c.req.makeUri("profile/", false) &
- # xmlEncode(latestReplyAuthor)
-
-# let posts = getValue(db, sql"select count(*) from post where thread = ?", %threadId)
-
-
${xmlEncode(%views)}
-
$posts
-
-
- #let latestReplyDate = getValue(db, sql("SELECT strftime('%s', " &
- # "(select creation from post where id = (select max(id) from post where thread = ?)))"), %threadId)
- #let timeStr = formatTimestamp(latestReplyDate.parseInt())
-
- ${xmlEncode(%userName)}
- #if c.userId == %postAuthor and c.currentPost.subject.len == 0:
- Edit post
- #elif c.rank >= Moderator and c.currentPost.subject.len == 0:
- Edit post
- #end if
-
- #if c.userId == %postAuthor and c.currentPost.subject.len == 0:
- Edit post
- #elif c.rank >= Moderator and c.currentPost.subject.len == 0:
- Edit post
- #end if
-
- #end if
- #if not isThread:
- #try:
- ${(%postContent).rstToHtml}
- #except EParseError:
- # c.errorMsg = getCurrentExceptionMsg()
- ${xmlEncode(%postContent)}
- #end
- #end if
- ${xmlEncode(%postCreation)}
-
-
-
-# end for
-
-# if c.pageNum > 1:
-
-# end if
-# if whCount[true] == ThreadsPerPage or whCount[false] == ThreadsPerPage:
-
-# end if
-#end proc
-#
-#
-#proc genFormResetPassword(c: var TForumData): string =
-# result = ""
-
nimforum uses a slightly-customized version of
- reStructuredText for formatting. See below for some basics, or check
- this link for a more detailed help reference.
Hey! I'm willing to create a programming language using nim.
+
+
It's an educational project. Been reading about compilers for weeks now and I started using tools like flex and bison for lexer and parser. I know nim have a parsing library but nowhere near that level.
+
+
There is an old post (2014) with a similar question so I'm bringing that back a few years later. Is there anything anyone know that could speed up the process of developing a programing language using nim? (I can have c code if needed ofc)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ twetzel59
+
+
Jan 2015
+
+
+
Wow, I was just reading about the compilation pipeline today!
+
+
I suppose you could use at least the lexing part from a generator like flex, not so sure about using AST generators easily (it's possible).
+
+
Is your language complicated enough to warrant a parser generator or could you just use a custom parser?
- } "${users[i][0]}"){kind=avatar}
- #end for
- 
+ 
+ 
+ 
+ 
+ 
+ 
+