Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Source code behind the Joind.in website - a community-driven site focused on bringing together the people sharing the knowledge with the ones giving feedback.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 doc
Octocat-spinner-32 src
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CHANGELOG
Octocat-spinner-32 README.rst
Octocat-spinner-32 build.xml
Octocat-spinner-32 testfile
README.rst

Joind.in (http://joind.in)

This is the source code for the Joind.in website - a resource set up to allow events to get real-time feedback from those attending. It also gives speakers a way to claim and track their presentations over time.

Quick start

  1. Create a vhost entry for the site. The docroot should be /src.
  2. Create a MySQL database with username and password. Use a database name of joindin.
  3. Initialise, patch, and populate the database.

`bash $ # Use the correct username and password $ src/scripts/patchdb.sh -t /path/to/joind.in -d joindin -u username -p password -i `

  1. Create directories for user-added content.

`bash $ mkdir src/system/cache/ctokens && chown apache:apache src/system/cache/ctokens $ # Your owner and group might be different for different webservers/distros `

  1. Create configuration files for database and config (based on the .dist templates), and edit these files as appropriate:

`bash $ cp src/system/application/config/database.php.dist src/system/application/config/database.php $ cp src/system/application/config/config.php.dist   src/system/application/config/config.php `

  1. Enjoy the site! The default password for all users is "password".

Detailed instructions

There's a few SQL files that are included with the source to help you get things up and running. The first four will bring your database to the most current, up-to-date status and ALL should be run for a new install:

doc/db/init_db.sql
Export of the initial data structure, ready for import (as exported from MySQL)
doc/db/init_data.sql
This file contains a few handy things for your database's initial setup like languages and session categories
doc/db/patch\*.sql
Numbered patch files to run in order after running init_db. All database changes to be managed using these, init_db does NOT get updated. For more information on this approach, see this article on a simple database patching strategy. Note: If patch 17 fails it can be skipped.
doc/db/seed_countries.sql
Some seed data for the countries table (needed for timezone selection)

We also have excellent sample data generation, check out /doc/dbgen/README for information about how to generate sample data to use with your installation.

This last SQL file will give you a jumping off point to see how the system works. It will populate your system with some seed data (talks, users, events) so you can see how they all relate:

doc/db/seed.sql
Some seed data you can load into your (MySQL) database to get the ball rolling.

Finally, there's some other scripts that come with the source to make things easier to setup:

  • Release of CodeIgniter
  • Sample cron jobs in /src/scripts

Additional Information

You can find more information on github. Issues should be submitted on the JIRA bug tracker

See the LICENSE file for license information for this software.

Installation

The following are the steps you'll need to correctly install the software:

  1. Download/clone the current repository and drop it into a web-accessible directory for your server.

  2. Set the document root to the /src directory.

  3. In the /src/system/cache directory, create a web server-writeable directory called "ctokens".

  4. In your src/system/application/config directory:

    1. Make a database.php file using the database.php.dist as a guide.
    2. Make a config.php file using the config.php.dist as a guide.
  5. Push the doc/db/init_db.sql file into your database.

  6. Apply any of the other patches in the /db folder.

If you'd like some seed data, you can use the seed.sql to load in a few events, users and talks. You'll also need to load in the seed_countries.sql file to get the complete list of countries for the event details.

The default password for users is "password".

Extensions

In order to run tests make sure you have the following extensions installed and configured. This library can be ignored if you are not planning on running tests.

pecl_http

$ pecl install pecl_http

in php.ini add:

  • linux: extension=http.so
  • windows: extension=http.dll

Debugging

By default the application is in production mode. This primarily means that error messages and notices are suppressed.

To allow errors and notices to be shown on the site you have to change the environment variable JOINDIN_DEBUG to the value 'on'. It is discouraged to do this on production environments as this will allow visitors to see any errors produced by the site.

The JOINDIN_DEBUG environment variable is controlled from the `accompanying .htaccess file`_.

Tests

There are some tests set up, which use PHPUnit; these can be found in the src/tests directory. There is an ant task configured to run them - from the root directory simply run "ant phpunit" to run the tests.

Note: The API tests actually call the service externally and rely on the pecl_http extension being installed to run.

Issues

The issue tracker is where all bugs and feature requests should be filed.

RewriteEngine

It is advisable to enable the RewriteEngine:

`bash sudo a2enmod rewrite `

The .htaccess file in /src takes care of all the rewrite rules.

Docutils System Messages

System Message: ERROR/3 (<string>, line 149); backlink

Unknown target name: "accompanying .htaccess file".
Something went wrong with that request. Please try again.