Skip to content

kimtrien/phanbook

 
 

Repository files navigation

Phanbook

Phanbook is the next-generation Q&A and Forum software that makes online discussion, question and answer site for professional and enthusiast people. Also the name Phanbook is mean - Phan(Phalcon PHP)book(the your note book)

Live Demo - Development Forum - Discourse Theme - Phalcon Theme - Contact

Build Status and Join chats us:

Build Status Slack

Goals

  • Fast and simple. No clutter, no bloat, no complex dependencies. Phanbook is built with Phalcon PHP so it's quick and easy to deploy.
  • Beautiful and responsive. This is Q&A software for humans. Phanbook is carefully designed to be consistent and intuitive across platforms, out-of-the-box.
  • Powerful and extensible. Customize, extend, and integrate Phanbook to suit your community. Phanbook's architecture is amazingly flexible, prioritizing comprehensive APIs and great documentation.
  • Easily deploy With Docker and Vagrant you can easy deploy to production with Docker and setup environment develop with Vagrant.
  • Blogging Create a beautiful, independent online publication
  • Free and open. Phanbook is released under the GNU General license.

Features

We want Phanbook to be the most powerful Q&A software out there, and we have a huge list of ideas that we want to implement. It will take time, but Phanbook’s flexible plugin system will mean we can release early and often. Here’s a snapshot of what we’ll be working on first:

  • Multiple Themes
  • Spam Blocking
  • Markdown and rich text editing support
  • Powerful search with Elasticsearch
  • Single sign-on (Facebook, Google, GitHub, etc.)
  • Topic/Tags subscriptions and digest emails
  • File attachments
  • Post flagging/reporting and an intelligent auto-moderation system
  • Rewards, badges, and gamification
  • Q&A format and voting
  • Simple CMS
  • The modular structure with a convenient hierarchy that is based on namespaces

Installation

Phanbook is currently in development and will be ready to use later this year. (Roadmap) If you want to give the development version a spin or are interested in contributing, for now you can install Phanbook's Vagrant image. An easier installation process will become a priority once Phanbook is more stable.

  1. Install Vagrant and VirtualBox.
  2. Clone this repository and set up the Vagrant box:
git clone --depth=1 https://github.com/phanbook/phanbook.git
cd phanbook && chmod +x phanbook && ./phanbook up
  1. Add an entry to your /etc/hosts file:

192.168.33.34 phanbook.dev

  1. Visit phanbook.dev or 192.168.33.34 in a browser. To get full information how to setup that can see here

Docker

To play Phanbook with Docker you just do follow a command below:

./phanbook docker #it will use default password is phanbook

Visit 127.0.0.1 in a browser. If you use Windows see more here

Default we have setup a user with:

  • Username: admin
  • Password: phanbook

Security

We take security very seriously at Phanbook; all our code is 100% open source and peer reviewed. Please read our security guide for an overview of security measures in Phanbook.

Contributing

Phanbook is 100% free and open-source. We encourage and support an active, healthy community that accepts contributions from the public – including you!

Before contributing to Phanbook:

  1. Please read the complete mission statements on phanbook.com. Yes we actually believe this stuff; you should too.
  2. Read and sign the Electronic Phanbook Forums Contribution License Agreement.
  3. Dig into CONTRIBUTING.md!, which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
  4. Not sure what to work on? We've got some ideas.
  5. Please note that bug reports should go in phanbook/phanbook or the relevant extension repository.

We are look forward to seeing your pull requests!

Donating

Support this project via gratipay.

Support via Gratipay

The Phanbook Team

The original Phanbook code contributors can be found in AUTHORS.MD. For a complete list of the many individuals that contributed to the design and implementation of Phanbook, please refer to the official Phanbook blog and GitHub's list of contributors.

Copyright / License

Copyright 2014 - 2015 Phanbook Construction Kit, Inc.

Licensed under the GNU General Public License Version 2.0 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

About

A Q&A, CMS and Discussions PHP platform

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 47.5%
  • JavaScript 24.3%
  • CSS 20.4%
  • Volt 6.7%
  • Ruby 0.6%
  • Shell 0.5%