Introduction
NFID-SDK is an open source software development kit that contains examples and packages for developers to integrate NFID into your application. The SDK is designed to provide an overview of all installable packages that will help you easily integrate the appropriate packages into your existing application and include the appropriate examples.
💡 The NFID-SDK is currently limited to integration with React applications only, and the team is actively developing to expand and include other libraries and components for integration, such as Vue and Svelte.
If you want to integrate NFID into your React application, we offer certain packages. nfid-sdk-react is the main package that you need to add to your project as a dependency. You can find more details about exactly what it does in the package itself. For all the packages NFID offers, check out the packages section.
We have also prepared some examples to show how we use these packages. This will ensure that you get a clear picture of what exactly is needed to fully integrate NFID.
A fully developed application with NFID integrated using React is available in the create-ic-app-react-demo example
💡 New to Internet Computer? Check out the introduction and get started!
Table of contents
DFX
We run on DFX v0.9.3 so you will need to install this specific version. If you have an older version, run this command to install this specific version:
DFX_VERSION=0.9.3 sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"
A step-by-step guide on how to set up your DFX can be found here.
Examples
The NFID-SDK also provides a set of examples of how to integrate NFID into your application, which can be found under the examples/* directory, and consists of the following examples:
| Repository | Description |
|---|---|
| create-ic-app-react-demo | A fully developed application with NFID integrated using React, built on top of an existing application from the community, and integration instructions for your own application. |
|
|
A sample application that demonstrates how to link your account to NFID. |
Packages
NFID-SDK consists of the following packages:
| Repository | Description |
|---|---|
| nfid-sdk-react | React component library to integrate with NFID into your application. |
| nfid-ui-kit-core | UI utility library with NFID branding, and is used by other sample applications within NFID-SDK. |
Guidelines
Read through our contribution guidelines before reporting an issue or contributing to the NFID-SDK.
Licensing
MIT © 2021 Internet Identity Labs, Inc
Contact us
💠 For all of our latest updates, you can follow us on Twitter
If you ran into any issues, have any questions, or have new awesome ideas, you can share them with us on GitHub Discussions or Discord.
2 Jan 1, 2023
10 Nov 5, 2022
4 Jan 2, 2023
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
280 Jan 2, 2023
47 Oct 17, 2022
10 Sep 30, 2022
20 Nov 6, 2022
5 Oct 25, 2022
7 Nov 26, 2022
13 Dec 27, 2022
4 Nov 7, 2022
17 Dec 2, 2022
12 May 9, 2022
5 Dec 8, 2022
89 Dec 20, 2022
9 Aug 10, 2022