General

Introduction

Flashcard Script is an easy-to-use script written in PHP. You do not need any programming knowledge to set it up. It comes with a web-based installer and a comprehensive administration panel. It is best suited for language teaching websites to provide opportunities for learners to enrich their vocabulary. However, it can be used for other purposes as well.

System requirements

The script requires at least:

  • PHP 7.0+
  • MySQL 7.+
  • mod_rewrite module enabled in Apache server

Please make sure you check your system before purchase!

Flashcardscript is a self-hosted software, meaning it needs to be uploaded and installed on a webserver. This documentation provides step-by-step instructions on the installation process, it does not require any special knowledge. while our script runs smoothly on most modern webhosts we cannot guarantee that it will do so on all. Therefore we recommend using A2hosting servers. We use these servers frequently during development so we know they will work. If you do not have a webhosting account yet, please consider using A2hosting’s services.

Installation

File upload

After downloading the install package, extract it to your hard drive. Upload all files and directories from the “upload” folder to your server, preferebly in a sub-directory.

You can upload the files using an FTP client such as FileZilla. If you are not familiar with using an FTP client, you can find a detailed tutorial on it in our knowledgebase.

Installing the script

Once you have uploaded all files and directories to your server, you are ready to install the script. Follow the points below:

1. In your browser, call the install script. Type: http://www.yoursite.com/flashcardscript/install/ and hit enter.

Replace “yoursite.com” with your domain, and “flashcardscript” with the name of the directory you uploaded the script.

2. You should see the web-based installer of the script.

 

Here you can see some information about the install process and system requirements. Make sure you have the database details at hand. Click “Continue”

3. Fill out the database details such as hostname, database name, database username and password then click “Continue”.

4. Create your administrative account.

 

5. Finish the installation by checking the checkbox to remove the installation directory. You should be able to log in to the script back-end by visiting the script’s URL at http://yoursite.com/directory-where-you-uploaded-the-script

Updating the script

To update the Flashcard script from a previous version follow these steps:

  1. Overwrite old files
  2. Run the update script by visiting the following URL: http://www.yourdomain.com/flashcard/install/update.php
  3. Change yourdomain.com to the name of your domain, and flashcard to the folder where you installed the script.
  4. Follow the on-screen instructions.

Administration

Add words

This page consists of four important boxes and a table where you can see the previously created words.

In the first box you can add a word or expression and its meaning. The word and the meaning must be separated by a “|” sign without quotation marks.

In the second box, you can upload an audio file to this word. Click the “Upload audio” button and select a file from your computer. The audio will be played each time the card appears with this word or if a user clicks on the audio icon next to the flashcard. Uploading an audio with the word is optional.

In the third box, you can add an example sentence to demonstrate the word on the card. This is, again, an optional setting. If you leave this blank, only the word and its meaning will appear on the card. You can use basic HTML here to format your text.

The fourth box is pretty self-explanatory. You can place the word in a previously created category.

In the “Available words” section, you can see all the words that have been created so far. You can also edit, delete or search for any words here.

Add categories

It is a good idea to start here after the installation is complete and create some categories. All you need to do is write the name of the category and click the “Add” button. You will immediately see your new category appear under the “Available categories” section. Here you can also edit or delete categories.

Add exercises

This is where you can create flashcard sets. First, you have to enter a title. This is only for administrative purposes. It will not be displayed on the front-end.

Then you can select the categories you would like to use with this flashcard set. Only words from the selected categories will be used in this exercise.

You can also choose whether to show words randomly or not.

If you added advertisements to the general settings page, you can choose to display those ads in an exercise.

“Enable inline ad” allows you to display ads between two flashcards. You can also choose how many times an inline ad should be shown in an exercise.

You can also enable another ad spot below the exercise. This ad will be shown throughout the exercise.

Here you also have email marketing settings. If you enabled this option in general settings you can use a subscription form between flashcards, similarly to inline ads.

Click on the “Save” button to save the exercise.

Once saved, you will see an embed code. Copy this code and paste it into any pages of your site.

General settings

Settings

On the “Settings” page you can change the “Site title” to match yours, and change the localization settings if there is available translation.

Ad settings


You have two ad spot that you can use. Here you can add Google Adsense code, or your own image banner.

Inline ad spot: will enable you to display ads inside an exercise, between flashcards.

Ad spot below exercise: will enable you to display an ad below the exervise.

Email marketing

Flashcard script provides an option to display email subscription form inside an exercise and grow your email list. Currently the script supports Mailchimp, ConvertKit and Sendinblue integration.

First choose which email service provider you would like to use then create your API key on their website. Once you have your API key, you can come back to the flashcard admin and select the email provider, add your API key and select the list you want to use here.

Profile

On the “Profile” page the site admin can change his or her personal details such as:

  • username
  • e-mail address
  • password
  • avatar image

Misc

Top