crude-forum/crude-forum

A very simple, crude and insecure web dicussion forum developed using PHP. Store data in text files in back-end.

Tuesday, July 3, 2018
by yookoala
Repository
1 Watchers
0 Stars
9 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
6 Versions
0 % Grown

The README.md

CrudeForum

![CI results][ci-badge] , _(*1)

A very simple, crude and insecure web dicussion forum developed using PHP. Store data in text files in back-end., _(*2)

Originally forked from github.com/stupidsing/crude_forum but changed drastically since., _(*3)

Prerequisites

The installation depends on composer. Install composer to your system $PATH., _(*4)

Development

All style changes should be done in forum.scss and built by sass. To setup for development:, _(*5)

Install nodejs to your system. The package manager npm will be installed along.
Then with npm, install sass to anywhere in your $PATH. Probably with this command:

npm install -g sass

Basic Install

Getting the project files

First, install CrudeForum into the folder myForum (which you may rename as you see fit):, _(*6)

composer create-project --prefer-dist crude-forum/crude-forum myForum

Note: If you do not have sass prior to running the composer create-project command, you'd need to run the composer build command to rebuild static assets after install:, _(*7)

composer run build

Web server configurations

Then setup your web server to use document of the full path to myForum/public. Please remember to setup your server to route to myForum/public/index.php by default., _(*8)

Nginx installation

, _(*9)

For [Nginx][nginx], assuming you have `$document_root` points to `myForum/public`, this means to have something like this in your config: ```nginx location / { ... fastcgi_param SCRIPT_FILENAME $document_root/index.php; ... } ``` , _(*10)

, _(*11)

Apache installation

, _(*12)

For [Apache][apache], please remember to setup [AllowOverride all][AllowOverride] in the appropriate [Directory] section so the [.htaccess](public/.htaccess) file can work for you. Probably something like this: ```apache DocumentRoot "/home/to/myForum/public" AllowOverride all ``` , _(*13)

, _(*14)

Should all the setup correct, you can now browse your forum in browser., _(*15)

Alternative Installation

For some legacy hosting environment, you might not be able to do path rewrite as modern PHP routing requires., _(*16)

CrudeForum support multiple routing strategies. For that, you may reference the examples:, _(*17)

Development

Simply clone this repository. You can run crude forum with modern PHP 7.1+ command line tools:, _(*18)

composer dev

which effectively runs php -S localhost:8080 -t ./public., _(*19)

If you want to continuously develop the CSS stylesheet, you may consider to use the watch mode of node-sass:, _(*20)

composer watch

Both watch and build requires [node-sass]. You may supply additional argument by using the -- syntax. For example, to watch and build asset with embeded source map:, _(*21)