API Documentation - Blockstale Payment API

Blockstale Documentation v1.0 by Folarin Martins


Introduction


First of all, Thank you so much for purchasing this project and for being my loyal customer. You are awesome!
You are entitled to get free lifetime updates to this product + exceptional support from the author directly.

This documentation is to help you regarding each step of customization. Please go through the documentation carefully to understand how this project is made and how to edit this properly. Basic HTML and CSS knowledge is required to customize this project. You may learn basics from the links below.

Learn HTML basics

Buyers Guide to Customizing HTML Projects

If you are new to HTML, I highly recommend that you watch the video tutorials below which I have outlined some basic steps for customizing HTML. Its 20 minutes long. But It worth it if you are a newbie.

Please note:
The demo shown in this video is based on another project, but it will definitely help you in editing any HTML project.

Requirements to Customize this Project

You will need the following sofwares to customize this project.

  1. Code Editing Software (eg: Dreamweaver, Sublime Text or Notepad++)
  2. Web Browser for testing (eg: Google Chrome or Mozilla Firefox)
  3. FTP Tool to upload files to Server (eg: FileZilla)
Be careful while editing the project. If not edited properly, the design layout may break completely.
No support is provided for faulty customization.

Getting Started #back to top

If you are able to read this documentation locally, which means you have successfully downloaded the package and extracted the zip. The file structure as follows :

    Blockstale/
    ├── Help Docs/   
    ├── HTML/
    │   ├── css/
    │   │   ├── plugins/
    │   ├── images/  
    │   ├── js/  
    │   │   ├── plugins/  
    │   ├── sass/  
                 

The folder you have to customize is the HTML folder. Copy HTML folder from the package and paste it in your Project Folder. (This helps you to prevent overwriting in original files. so if you messed up something, you will get the original here.)

Pages #back to top

Here are the list of HTML Pages included with this project

  1. Landing Style One index-one.html
  2. Landing Style Two index-two.html

Page Settings #back to top

Once you have finalized your preferred layout for the Homepage, rename the file name to index.html It is required to use the same name to make it work as default page when you upload to your server.

Color Theme #back to top

By Default, this project uses two color theme via SASS (SCSS. New and Fast, need some knowledge). By using SASS, it is really easy to change to any color theme you want by just changing a single variable. or if you prefer, you may change the CSS Manually (Old way)

SASS is a popular CSS preprocessor to make writing CSS much easier. Learn more

Changing Color theme using SASS

  1. Open /scss/_[theme]-variables.scss and /scss/_user-variables.scss in your code editor
  2. find the variable you would live to change. For example $body-color: $blue-gray; from theme variables.
  3. Now copy the line and paste it in to your _user-variables.scss file and then modify it.
  4. If you are reffering another variable like $blue-gray; as in the example above,
    you might also need to copy the $blue-gray: #b4bdff; line before the other and then you will be able to modify the value.
  5. Now Save and Complie the SASS to CSS (How to compile?) to see the changes
  6. Wohoo! You're done.

Extras #back to top

Web Hosting #back to top

Once you have finished all customizations, The next step is to upload your to a Live Hosting Server. For that you will need to buy a Hosting Plan and a Domain name from a Service Provider.

Compare & Buy Web Hosting

Uploading to Server #back to top

Once you have registered a domain name and Hosting, You will get FTP details from your hosting provider. Use that login details to connect with your server. You will need an FTP Software for this such as FileZilla. Connect with your server and open /public_html folder in your server. Then copy all HTML, CSS and JS files from your local machine to your root /public_html folder in your server. Please note the HTML files should be in the Server's root folder. If your local project is in /your-folder/ Do not upload the folder directly. Instead open the folder and select all HTML files and CSS, JS folders and upload.

Website Optimization Tips #back to top

A Fast & Optimized Website has several factors which needs to be implemented in order to achieve the desired results. There are several Optimization Techniques available which will definitely affect your Website's Performance in a Positive Way & we want to share a few of them with you:

  1. gZip Compression & Browser Caching

    This is probably one of the Most Important Techniques you should definitely implement in order to bump up your Website's Loading Speed. gZip Compression is used to compress the Files that are delivered when loading a Website. It covers HTML, CSS, Javascript & Font Files along with other miscellaneous text files. Where as Browser Caching also covers Images & Videos apart from including the above files. This is used to saves the Static Data in your Browser itself so that when you open the Next Pages on the Same Website, the content does not gets Downloaded again, loading the Website fast.

    gZip Compression & Browser Caching can be enabled using the .htaccess File on an Apache Web Server. You can use the Codes from here: https://github.com/h5bp/html5-boilerplate/blob/master/dist/.htaccess to enable these modules on your server.

  2. Image Compression & Optimization

    We tend to use Lots of Images on our Websites but we often do not make efforts to Compress & Optimize them. Remember, the Larger the Image, the more time it takes to download and therefore this slows your website loading times affecting User Experience. Your customer will leave your website if it does not load within 3-5 Seconds which adversely affects your Sales. Therefore, it is important to Resize, Optimize & Compress your Images before using it on your Website. Here are some Tips which might come handy in optimizing images:

    1. Resize your Images: Resize your Images before using it on your Website. Do not just Download an Image & place it as it is in your Website's <img> Tag without resizing it. The size/resolution of the Image matters since it is not recommended to use an Image size of 1200px x 800px in a Content Size of 300px x 200px as this is unnecessary. Resize it to 300px x 200px
    2. Image Formats: There are three common file types that are used for web images which are JPEG, GIF, & PNG. For images with a Flat Background use JPEG images, for images with a Transparent background use PNG images and for images with Animations use GIF images.
    3. Compressing Images: Images Compression is important as it considerably reduces the size without losing the quality. There are several FREE Image Optimization Tools available to Download.
      For MAC use ImageOptim
      For Windows use Riot for compressing JPEG Images & PNG Gauntlet for PNG Images.
  3. CSS & jQuery Minifications

    It is also recommended that you Combine & Minify all your CSS Files to a single CSS File & all Javascript Files to a single JS File since Minification reduces the size of the File and Combining the files helps in reducing the number of HTTP requests made to the server. This is also an Important Factor in increasing the speed of your website. There are several tools available online to Minify your CSS & JS Files. Our recommendations are:
    For CSS use CSS Minifier and For Javascript use Javascript Minifier.

  4. Content Delivery Network

    You can use a CDN to further speed up your website. You can use the CDN to deliver static files of your website like CSS, JS, Images & Font Files. There are several CDN Hosting Providers available on the Internet but we would recommend MaxCDN or CloudFlare. Note: CDN setup requires Extra monthly Fees to setup, so it is completely optional & according to your needs. Cloudflare also has a Free plan, you can try that for free.

  5. Fast Web Hosting Servers

    A lot depends on your Web Hosting Servers, so it is recommended that you choose a Hosting Company/Server that provides a Reliable & a Fast Hosting Service. You can also choose our shared hosting plans. See above.

Check Google Page Speed Check Gtmetrix Grade

Credits #back to top

We are really thankful to the makers of the frameworks, plugins and images below. We used these to make this more functional. Demo images, you have seen in Live Demo is not included in the download package because of their copyright restrictions.

Frameworks

  1. Bootstrap

Plugins

  1. Validate JS

Libraries

  1. jQuery

Images / Videos

  1. Unsplash
  2. Depositphotos

Changelog #back to top

How to Upgrade #back to top

If you have purchased an earlier version and want to upgrade your website to the newwer version of this project, You can follow the steps. In each update, we will keep a changelog or version history, where we will keep the log of all changes made. We will list out the Changes made, Features added and Pages modified. So it will be easier for you to replace the existing.

If you have modified a file which has latest update, for example, CSS, Open both page in a code editor and use a Comparison Sofware or an Online Tool like Diff Now to compare changes in both files. Then you can manually copy paste the changed lines without affecting your file. NOTE: We recommend that you keep a separate file for new additions or changes if possible.

Version 1.0 (19 July, 2019) #back to top

Initial Version

Rate it #back to top

If you like the project, Please consider Rating it on Facebook by our fans page : http://blockstale.com That means a lot to us :)

rate this project

Support #back to top

Please remember you have purchased a very affordable project and you have not paid for a full-time web design agency. Occasionally we will help with small tweaks, but these requests will be put on a lower priority due to their nature. Please be patient, polite and respectful. We will try to answer your questions as soon as possible

Support for my items includes:
  1. Responding to questions or problems regarding the item and its features
  2. Fixing bugs and reported issues
  3. Providing updates to ensure compatibility with new software versions
Item support does not include:
  1. Customization and installation services
  2. Support for third party software and plug-ins
Before making a support request, please do...
  1. Make sure your question is a valid issue and not a customization request.
  2. Make sure you have read through the documentation and any related guides before asking support on how to accomplish a task.
  3. Try to use "Google Search" for common questions. Most of the times, which will help faster than the support.

Contact Support

Thank you! #back to top

Once again, Thank you so much for purchasing this project and being by loyal customer. You can reach me pesonally on Twitter @blockstale or via my Email (No Support requests please.. use support website instead)


Copyright © Blockstale. All rights reserved.