Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

2factorauth/dev

 
 

Repository files navigation

TwoFactorAuth.org

Build Status License Gitter Twitter

A list of popular sites and whether or not they accept two factor auth.

The Goal

The goal of this project is to build a website (TwoFactorAuth.org) with a list of popular sites that support Two Factor Authentication, as well as the methods that they provide.

Our hope is to aid consumers who are deciding between alternative services based on the security they offer for their customers. This project also serves as an indicator of general security efforts used on a site.

Contributing ✏️

If you would like to contribute, please read the entire guidelines here in CONTRIBUTING.md.

Local installation 🛠️

TwoFactorAuth.org is built upon Jekyll, using the github-pages gem. In order to run the site locally, bundler, and all other dependencies will need to be installed, and afterwards Jekyll can serve the site. Ubuntu:

sudo snap install ruby --classic
sudo apt install webp npm
npm i babel-minify
bundle install --path vendor/bundle

Windows Subsystem for Linux (WSL)

sudo apt install build-essential ruby-bundler ruby-dev make gcc g++ zlib1g-dev npm webp
npm i babel-minify
bundle install --path vendor/bundle

MacOS (Requires Xcode)

# Install homebrew
xcode-select --install
curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh

# Install ruby, webp & nodejs(npm)
brew install ruby
brew install webp
brew install nodejs
echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.bash_profile

# Install Bundler and gem dependencies
gem install bundler
bundle install --path vendor/bundle

Running locally 🏃

Ubuntu/WSL/MacOS:

# Generating regional sites (Optional)
ruby ./_deployment/regions.rb

# Minify JS (Optional)
./_deployment/minify-js.sh

# Generate WebP images
./_deployment/webp.sh

# Building the site
bundle exec jekyll build

The TwoFactorAuth website should now be accessible from http://localhost:4000.

Another option is to run Jekyll inside a Docker container. Please read the Jekyll Docker Documentation on how to use Jekyll.

License ⚖️

This code is distributed under the MIT license. For more info, read the LICENSE file distributed with the source code.

Packages

No packages published

Languages

  • SCSS 61.7%
  • HTML 20.6%
  • Ruby 9.5%
  • JavaScript 5.6%
  • Shell 2.6%