Skip to content

FreeClimbAPI/Node-2FA-How-To-Guide

Repository files navigation

Node 2FA Sample App

code style: prettier JavaScript Style Guide License: MIT Build Status Coverage Status

This project serves as a guide to help you build a 2FA (Two-Factor Authentication) application with FreeClimb.

Specifically, the project will:

  • Get a phone number from the user
  • Send a verification code to the user's phone
  • Get the verification code from the user
  • Expire the verification code after a set amount of time
  • Verify the code

How-To Guide

We offer a Two-Factor Authentication (2FA) how-to guide for more detailed set-up instructions and explanation of how the code in this 2FA sample app works.

Requirements

A FreeClimb account

A registered application with a named alias

A configured FreeClimb number assigned to your application

Trial accounts: a verified number

Tools:

Setting up the Sample App

  1. Install the required packages

    yarn install
  2. Create a .env file and configure the following environment variables within it:

    ENV VARIABLE DESCRIPTION
    ACCOUNT_ID Account ID which can be found under API credentials in dashboard.
    API_KEY Authentication token which can be found under API credentials in dashboard
    FC_PHONE_NUMBER A configured FreeClimb Number that will send verification codes. To learn more, go here.
    PORT Specifies the port on which the app will run (e.g. PORT=3000 means you would direct your browser to http://localhost:3000).

Running the Sample App

  1. Start the app

    yarn start

Feedback & Issues

If you would like to give the team feedback or you encounter a problem, please contact support or submit a ticket in the dashboard.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published