gosora/README.md

# Grosolo

A super fast forum software written in Go.

The initial code-base was forked from one of my side projects, and converted from the web framework it was using.


# Features
Basic Forum Functionality

Custom Pages


# Dependencies

Go. The programming language this program is written in, and the compiler which it requires. You will need to install this. https://golang.org/doc/install

MySQL Database. You will need to setup a MySQL Database somewhere. A MariaDB Database works equally well, and is much faster than MySQL.
If you're curious about how to install this, you might want to try the WNMP or XAMPP bundles on Windows.
Instructions on how to do so on Linux: https://downloads.mariadb.org/mariadb/repositories/


# Installation Instructions

**Run the following commands:**

go install github.com/go-sql-driver/mysql

go install golang.org/x/crypto/bcrypt

Tweak the config.go file and put your database details in there. Import data.sql into the same database. Comment out the first line (put /* and */ around it), if you've already made a database, and don't want the script to generate it for you.

Set the password column of your user account in the database to what you want your password to be. The system will encrypt your password when you login for the first time.


# Run the program

go run errors.go main.go pages.go reply.go routes.go topic.go user.go utils.go forum.go group.go files.go config.go

Alternatively, you could run the run.bat batch file on Windows.


# TO-DO

Oh my, you caught me right at the start of this project. There's nothing to see here yet, asides from the absolute basics. You might want to look again later!


More moderation features.

Fix the custom pages.

Add emails as a requirement for registration and add a simple anti-spam measure.

Add an alert system.

Add a report feature.

Add a complex permissions system.

Add a settings system.

Add a plugin system.

Tweak the CSS to make it responsive.

Nest the moderation routes to possibly speed routing up a little...?

Add a friend system.
Initial commit 2016-12-02 07:23:26 +00:00			`# Grosolo`
Update README.md 2016-12-02 07:32:57 +00:00
			`A super fast forum software written in Go.`

			`The initial code-base was forked from one of my side projects, and converted from the web framework it was using.`


Fixed logging in. Added a new configuration variable. 2016-12-02 09:29:45 +00:00			`# Features`
			`Basic Forum Functionality`

			`Custom Pages`

Update README.md 2016-12-02 07:32:57 +00:00
			`# Dependencies`

Added tips on how to install Go and MySQL / MariaDB. 2016-12-05 10:44:19 +00:00			`Go. The programming language this program is written in, and the compiler which it requires. You will need to install this. https://golang.org/doc/install`
Update README.md 2016-12-02 07:32:57 +00:00
			`MySQL Database. You will need to setup a MySQL Database somewhere. A MariaDB Database works equally well, and is much faster than MySQL.`
Added tips on how to install Go and MySQL / MariaDB. 2016-12-05 10:44:19 +00:00			`If you're curious about how to install this, you might want to try the WNMP or XAMPP bundles on Windows.`
			`Instructions on how to do so on Linux: https://downloads.mariadb.org/mariadb/repositories/`
Update README.md 2016-12-02 07:32:57 +00:00

			`# Installation Instructions`

			`Run the following commands:`

			`go install github.com/go-sql-driver/mysql`

			`go install golang.org/x/crypto/bcrypt`

Don't forget to import data.sql 2016-12-02 15:10:28 +00:00			`Tweak the config.go file and put your database details in there. Import data.sql into the same database. Comment out the first line (put /* and */ around it), if you've already made a database, and don't want the script to generate it for you.`
Update README.md 2016-12-02 07:32:57 +00:00
Fixed logging in. Added a new configuration variable. 2016-12-02 09:29:45 +00:00			`Set the password column of your user account in the database to what you want your password to be. The system will encrypt your password when you login for the first time.`

Update README.md 2016-12-02 07:32:57 +00:00
Made it easier to configure. Seperated admins from super admins. 2016-12-02 08:07:56 +00:00			`# Run the program`

Static files are now served from memory. This feature's a little experimental, so it will need a lot of testing i.i Added an executable file. Only works on Windows, if it doesn't work, then try building it for yourself with build.bat or go build Tweaked run.bat to make it more firewall friendly. It now generates an executable. Moved the files around to make it more organised. Added build.bat which you can use to build the program for you and install the libraries the software depends on. 2016-12-05 07:21:17 +00:00			`go run errors.go main.go pages.go reply.go routes.go topic.go user.go utils.go forum.go group.go files.go config.go`
Made it easier to configure. Seperated admins from super admins. 2016-12-02 08:07:56 +00:00
			`Alternatively, you could run the run.bat batch file on Windows.`

Update README.md 2016-12-02 07:32:57 +00:00
			`# TO-DO`

			`Oh my, you caught me right at the start of this project. There's nothing to see here yet, asides from the absolute basics. You might want to look again later!`


			`More moderation features.`

Added the ability to upload and use avatars. 2016-12-02 15:03:31 +00:00			`Fix the custom pages.`

			`Add emails as a requirement for registration and add a simple anti-spam measure.`

Update README.md 2016-12-02 07:32:57 +00:00			`Add an alert system.`

			`Add a report feature.`

			`Add a complex permissions system.`

			`Add a settings system.`

			`Add a plugin system.`
Fixed logging in. Added a new configuration variable. 2016-12-02 09:29:45 +00:00
			`Tweak the CSS to make it responsive.`
Added the forums. Added the forum list. Added the forum view. Added a relative time utility function. 2016-12-03 13:45:08 +00:00
Added the profile system. Added the profile comment system. Added group tags. Improved the avatar placement logic. Users without avatars will now get noavatars. Customisable in config.go Only admins can see the Control Panel link now. Fixed a problem with Git not including /uploads/ which can crash the program. Database changes: Added active column to forums. Added tag column to users_groups. Added the users_replies table. Commented out the replies_reports table. 2016-12-07 09:34:09 +00:00			`Nest the moderation routes to possibly speed routing up a little...?`

			`Add a friend system.`