neoteric_qa

README

###Neoteric QA

Neoteric QA is a question-and-answer web application modelled (very) loosely after a popular public website.

###Development Status

Currently pre-alpha, the basic functionality works, but the following features are not yet implemented:

• RPM packaging, SystemD .service file, documentation, etc...
• Proper logging

Other features may still have rough edges

####Features:

• Private Q&A sites, perfect for corporate knowledgebases
• Questions, answers and comments are edited using Markdown syntax
• Performant and scalable
• Written in Go and MongoDB

###Compiling ####Initial setup of GOPATH and the Go environment

# only do this once
mkdir -p ~/src/neoteric_qa/src/github.com/neoteric-cm
export GOPATH=~/src/neoteric_qa
cd ~/src/neoteric_qa/src/github.com/neoteric-cm
git clone https://github.com/neoteric-cm/neoteric_qa.git
cd neoteric_qa
go get

####Running from the Source Code

# Requires a config file
make
./neoteric_qa -example-config > example-config.json
# This launches a development instance of mongod,
# you can pass additional arguments to mongod using
# MONGOD_ARGS='...'
make run

####Build and Install

export GOPATH=~/src/neoteric_qa
cd ~/src/neoteric_qa/src/github.com/neoteric-cm/neoteric_qa
make
# optionally use DESTDIR and PREFIX
make install

####Running the Compiled Binary

# Requires a mongod instance running, you can also launch one manually
systemctl start mongod
cd /opt/neoteric_qa
# Requires a config file
./neoteric_qa -example-config > example-config.json
./neoteric_qa -config example-config.json

See the Makefile for additional targets