StarterGuide

StarterGuide

A Starter Guide for new and experienced web developers

Introduction

Welcome to Yapeal Starter Guide.

This is a Starter Guide for both new users to Yapeal and a reference for experienced users, on how Yapeal is meant to be used and how to setup Yapeal to run smoothly on you website.

NOTE: This project is still a beta, which should be stable, but since it’s beta it can contain errors that we might not be aware of.

Requirements

Yapeal have some requirements to work correctly.

PHP 5.2.4 or greater with following extensions:

• curl
• date
• hash
• mysqli
• SPL
• xmlreader

MySQL 5.0 or greater

You should be able to run a Crontab (Windows users can use Task Scheduler), since Yapeal is meant to be run as a background library in CLI (Command-line interface) mode. More information on setting up a crontab job for Yapeal can be found at [crontabSetup].

Able also to run CLI manually, since you will need that to be able to install Yapeal.

Downloading Yapeal

There are two ways to get Yapeal.

1. You can download Yapeal latest stable release from:
   Source Forge
2. (Advanced users) You can use Mercurial to get the latest release. You will find instructions on how to clone it from:
   SF Yapeal Mercurial

Installing Yapeal

These instructions assume you have downloaded the archive file and you are now ready to extract from the archive file.

Windows:

Use the built-in zip handling of Vista or Win7’s Windows Explorer to extract Yapeal where you want to put it. A path without any spaces in it is recommended as it saves you having to quote things when working from the command line. For example C:\yapeal\ is better than “My Documents” but either should work.

Linux:

cd /where/I/want/to/put/it/

tar -jxvf /where/I/downloaded/archive/yapeal-latest.tar.bz2

After Extracting or Pull From Mercurial

Go into the directory where you put Yapeal and open INSTALL.md in your favorite text editor or with your web browser and follow the instructions starting from step 3, since step 1 and 2 is the same as what you just did here.

Next: [YapealSettings]