{"id":19035697,"url":"https://github.com/freeclimbapi/node-2fa-how-to-guide","last_synced_at":"2025-04-23T18:53:57.640Z","repository":{"id":52897559,"uuid":"336105297","full_name":"FreeClimbAPI/Node-2FA-How-To-Guide","owner":"FreeClimbAPI","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-18T16:41:38.000Z","size":259,"stargazers_count":0,"open_issues_count":0,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-18T04:12:49.646Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FreeClimbAPI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-02-04T23:00:15.000Z","updated_at":"2024-10-18T16:41:43.000Z","dependencies_parsed_at":"2024-07-11T19:03:32.713Z","dependency_job_id":"1384f98b-7794-4649-9474-5f0fc81bb36d","html_url":"https://github.com/FreeClimbAPI/Node-2FA-How-To-Guide","commit_stats":null,"previous_names":["freeclimbapi/node-2fa-how-to-guide"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FNode-2FA-How-To-Guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FNode-2FA-How-To-Guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FNode-2FA-How-To-Guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeClimbAPI%2FNode-2FA-How-To-Guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FreeClimbAPI","download_url":"https://codeload.github.com/FreeClimbAPI/Node-2FA-How-To-Guide/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250496736,"owners_count":21440228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T21:51:48.744Z","updated_at":"2025-04-23T18:53:57.619Z","avatar_url":"https://github.com/FreeClimbAPI.png","language":"JavaScript","readme":"# Node 2FA Sample App\n\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n[![Build Status](https://travis-ci.com/FreeClimbAPI/Node-2FA-Tutorial.svg?branch=master)](https://travis-ci.com/FreeClimbAPI/Node-2FA-Tutorial)\n[![Coverage Status](https://coveralls.io/repos/github/FreeClimbAPI/Node-2FA-Tutorial/badge.svg?branch=master)](https://coveralls.io/github/FreeClimbAPI/Node-2FA-Tutorial?branch=master)\n\nThis project serves as a guide to help you build a 2FA (Two-Factor Authentication) application with [FreeClimb](https://docs.freeclimb.com/docs/how-freeclimb-works). \n\nSpecifically, the project will:\n\n-   Get a phone number from the user\n-   Send a verification code to the user's phone\n-   Get the verification code from the user\n-   Expire the verification code after a set amount of time\n-   Verify the code\n\n## How-To Guide\nWe offer a [Two-Factor Authentication (2FA) how-to guide](https://docs.freeclimb.com/docs/two-factor-authentication-tutorial) for more detailed set-up instructions and explanation of how the code in this 2FA sample app works.\n\n## Requirements\n\nA [FreeClimb account](https://www.freeclimb.com/dashboard/signup/)\n\nA [registered application](https://docs.freeclimb.com/docs/registering-and-configuring-an-application#register-an-app) with a named alias\n\nA [configured FreeClimb number](https://docs.freeclimb.com/docs/getting-and-configuring-a-freeclimb-number) assigned to your application\n\nTrial accounts: a [verified number](https://docs.freeclimb.com/docs/using-your-trial-account#verifying-outbound-numbers)\n\nTools:\n- [Node.js](https://nodejs.org/en/download/) 12.14.0 or higher\n- [Yarn](https://yarnpkg.com/en/)\n\n\n## Setting up the Sample App\n\n1. Install the required packages\n\n    ```bash\n    yarn install\n    ```\n\n2. Create a .env file and configure the following environment variables within it:\n\n    | ENV VARIABLE    | DESCRIPTION                                                                                                                                                                                                                               |\n    | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n    | ACCOUNT_ID      | Account ID which can be found under [API credentials](https://www.freeclimb.com/dashboard/portal/account/authentication) in dashboard.                                                                                                            |\n    | API_KEY      | Authentication token which can be found under [API credentials](https://www.freeclimb.com/dashboard/portal/account/authentication) in dashboard                                                                                                  |\n    | FC_PHONE_NUMBER | A [configured FreeClimb Number](https://www.freeclimb.com/dashboard/portal/numbers) that will send verification codes. To learn more, go [here](https://docs.freeclimb.com/docs/getting-and-configuring-a-freeclimb-number). |\n    | PORT | Specifies the port on which the app will run (e.g. PORT=3000 means you would direct your browser to http://localhost:3000). | \n\n## Running the Sample App\n\n1. Start the app\n\n    ```bash\n    yarn start\n    ```\n\n## Feedback \u0026 Issues\nIf you would like to give the team feedback or you encounter a problem, please [contact support](https://www.freeclimb.com/support/) or [submit a ticket](https://freeclimb.com/dashboard/portal/support) in the dashboard.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreeclimbapi%2Fnode-2fa-how-to-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreeclimbapi%2Fnode-2fa-how-to-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreeclimbapi%2Fnode-2fa-how-to-guide/lists"}