https://github.com/scanapi/website
Website for ScanAPI testing framework.
https://github.com/scanapi/website
hacktoberfest jekyll netlify ruby scanapi website
Last synced: 18 days ago
JSON representation
Website for ScanAPI testing framework.
- Host: GitHub
- URL: https://github.com/scanapi/website
- Owner: scanapi
- License: mit
- Created: 2020-05-29T19:10:28.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T14:57:39.000Z (6 months ago)
- Last Synced: 2025-04-12T02:11:36.340Z (18 days ago)
- Topics: hacktoberfest, jekyll, netlify, ruby, scanapi, website
- Language: SCSS
- Homepage: https://scanapi.dev
- Size: 22.8 MB
- Stars: 10
- Watchers: 13
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/gracious-cray-a1ce6a/deploys)
# ScanAPI Website
Website for [ScanAPI](https://github.com/scanapi/scanapi) testing framework.
Available at: [scanapi.dev](https://scanapi.dev)
## Tech Stack
- [Jekyll](https://jekyllrb.com)
- Deploys by [Netlify](https://www.netlify.com)
## 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](https://www.ruby-lang.org/en/downloads/)
- We will not go into details of the ruby installation step by step as it is not the focus
### Jekyll
- After installing ruby, [install](https://jekyllrb.com/docs/installation/) 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](https://rvm.io) 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](https://rubygems.org/pages/download), [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/)
## Run
```bash
$ bundle exec jekyll serve
```