4jhan node.js server

4jhan, inspired by 4chan, is a minimal server-client network, where a board ( f.e.: /b/, /g/, /pol/,etc.) are hosted on individual servers. These servers only host JSON data and have to be interpreted via clients (native or web). See paths for specifics. By default the server will host on port 3000. If you want a different port, specify it in the PORT env variable.

Feel free to contribute! Possible tasks can be found in the TODO wiki page

The server is written in node.js and was tested on Linux (Fedora, Arch, Debian). It is lightweight enough to be run on a Raspberry Pi. This is open (MIT, see LICENSE) and work-in-progress software, expect errors and keep updated.

Setting up

After cloning the project, packages have to be installed before using from the project directory via npm:

$ npm install

By default 4jhan will use a SQLite database, and shoud work well enough for most situations. Data processing is done via node-orm2, and therfore can also connect to MySQL and PostgreSQL. How to specifically set up the connection, can be found within their wiki page

To start server , type:

$ ./bin/www

Optionally add & to run in background. If you want to let it run on another computer in the background, make sure it has SSH and type:

ssh user@host -f "/path/to/www/bin"

It will now be running in the background.

Note: Don't copy directly. Duh.

For more information (config, paths, help, h etc.), take a look at wiki