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

In short

1. You can modify the software.
2. You don't need to share the modifications you made to it.
3. You can resell the software.

Get Rikisimo

You can get the latest Rikisimo version at http://ivanribas.com/rikisimo/.

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

Requirements

• Apache server on Linux.
• mod_rewrite.
• PHP 5.2.6 or greater with GD library.
• MySQL 5 or greater.
• PCRE with Unicode support.
• Optional: PHP filesystem functions with allow_url_fopen enabled for Bit.ly integration.

Install

1. Upload the contents of the rikisimo folder to your server, make sure you upload the .htacces files, as this files may be hidden by your operating system or ftp client.
2. Point your browser to your server and enter your database name, username and password.
3. Register the first user as it will have admin permissions. You'll be redirected to the settings page.

You will need a Google Maps API Key, you can get it at http://code.google.com/apis/maps/signup.html

Update

If you are updating from a previous version backup all your data. Run app/config/sql/update.sql in your database to update the scheme if needed and upload the new script files.

Rikisimo admin

First registered user will have admin permissions, so make sure to sign up your own user once the installation is done.

Settings

In the admin panel you will find this settings:

• Application name: sets the application name.
• Slogan: is used as default page title.
• Admin email: the email address used to send messages and notifications to the site admin.
• System email: the email address used to send notifications to users.
• Country: if set users will only be allowed to enter listings for this country.
• City: if set users will only be able to enter listings for this city.
• Language: sets your web site language. Default is english (eng) but spanish (spa) translation is also included. See the translation section below to translate to your own language.
• Only admin can add listings: enable this option if you want only admin user to submit listings.
• Only admin can register new users: If selected only admin user would be able to add new users.
• Users must validate their email address: when this option is enabled an email will be sent to users to confirm their email address. Users won't be able to log in until the email address has been confirmed.
• Google Maps API key: the google api key to use the maps in your site.
• Recaptcha: add your recaptcha public and private keys to make use of recaptcha.
• Bit.ly username and key: if set the script will attempt to automatically create short urls for your restaurants so you can use it in twitter.

Translate

All translations are located in app/locale/. Default site language is English and the Spanish translation is also included. If you need to translate it to your own language you can do so with just one .po file.

To translate it into a new language just copy app/locale/spa and rename it according to your language iso639-2 code.

Example: 

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

You can get it a list of language codes in http://www.loc.gov/standards/iso639-2/php/English_list.php.

Then translate the file default.po into your language Translating the msgstr strings.

Example:

msgid "Previous"
msgstr "Anterior"

msgid "Next"
msgstr "Siguiente"

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

You can add your own strings to this file if you need to add new multilingual text in your site, then just use the function __(msgid) to translate strings in your html templates.

CUSTOMIZE

Css, javascript and images are placed in the app/webroot folder, but 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_default.ctp and you can edit this files as regular HTML code in any text editor.

The homepage template is app/views/nodes/home.ctp

The About, Terms and conditions pages are in the app/view/pages/ folder.

You can also customize the PHP code if you need to. Rikisimo uses MVC provided by the Cakephp framework. Model files are located in app/models, Controllers in app/controllers, and views in app/views.