Compitravel - PHP travelers social network manual

License

The MIT License

Copyright (c) 2008 Ivan Ribas

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

What is Compitravel?

Compitravel is a PHP script that allows you to create a social network for travelers. It makes use of Google Maps and Geonames web service to show places to the users and allows them to post comments, create groups and send private messages among other things.

Get Compitravel

You can get the latest Compitravel version donating to the project at http://ivanribas.com/compitravel/.

Subscribe to the mailing list to be updated on new versions and special offers.

Requirements

Apache server on Linux.
mod_rewrite.
PHP5 or greater with the GD library.
MySQL 5 or greater.
Google Maps API Key.
* A Geonames account is recomended (optional).

Install

Upload the contents of the compitravel folder to your DocumentRoot's server, make sure you upload the .htaccess files, as this files may be hidden by your operating system or ftp client.
Open your website with the browser and enter your database name, username and password.
Register the first user as it will have admin permissions.
Configure your site in the admin settings panel.

Settings

This are some of the settings you will find in the admin panel:

Application name: the name of your website application
Application slogan: slogan for your website application
Admin email: the email of the site administrator
System email: email address your system will use to send notifications to the users
Language: language used in the website, default is English.
Verify users email addresses: check it to force the users to verify their email address
Geonames Username: set your geonames username if you have one
Geonames token: set your geonames token if you have one
Geonames language code: geonames language code, the language in which place names are retrieved
Google Maps key: your google maps api key
Page header: text or code to be inserted in the page header
Page footer: text or code to be instered in the page footer

Translate

All translations are located in app/locale/ and the default language in Compitravel is English but the Spanish translation is also included.

To translate Compitravel into a new language you can use the Spanish translation file as a template, just rename the app/locale/spa folder acording to your language iso639-2 code.

Example: 

spanish		-> spa
french		-> fre
german		-> deu
italian		-> ita
portuguese	-> por

List of language codes: http://www.loc.gov/standards/iso639-2/php/English_list.php.

Then translate the default.po's file msgstr fields.

Example:

msgid "Previous"
msgstr "Anterior"

msgid "Next"
msgstr "Siguiente"

Note: translate the msgstr string only and keep the msgid in English.

Note on translations: Do not translate the country names in the database, translate the files in locale/ instead.

Customize

Css, javascript and images are placed in app/webroot. HTML templates are placed in app/views/.

The folders you see in app/views/ contain HTML templates you can edit, and the most important one is the layouts/default.ctp file, wich is the main layout used in all the site. Admin uses a different layout named admin.ctp.

The homepage template is app/views/users/login.ctp

The About and Terms and conditions pages are in the app/view/pages/ and you can edit them like regular HTML files.