ScanAPI Website

Website for ScanAPI testing framework.

Available at: scanapi.dev

Tech Stack

• Jekyll
• Deploys by Netlify

Development

Install

Ruby

• It is necessary to have ruby to run jekyll, to perform the verification with the following code, run ruby -v, if you return the version of ruby, you have it installed on your machine, otherwise install following the steps in documentation here
  • We will not go into details of the ruby installation step by step as it is not the focus

Jekyll

• After installing ruby, install jekyll
  1. Run the command gem install bundler jekyll
  2. Check if the installation was successful by running the command jekyll -v
  3. To execute the project live, run the command bundle exec jekyll serve

⚠️ Troubleshooting

1. Error of the outdated version of ruby, this is due to the Jekyll running only in versions >= 2.5.0. To correct it, you need to install a newer ruby version. We encourage you to use RVM to manage your Ruby versions.

2. Absence of gcc, make, and rubygems. This is due to Jekyll having pre-requisites. To verify if they are installed:

   • Run the comands, ruby -v, gem -v, gcc -v, g++ -v and make -v
   • RubyGems, GCC and Make

Run

$ bundle exec jekyll serve