https://github.com/noctisatrae/farsign

A work-in-progress & developer-friendly sign-in package for Farcaster
https://github.com/noctisatrae/farsign

Last synced: about 2 months ago
JSON representation

A work-in-progress & developer-friendly sign-in package for Farcaster

• Host: GitHub
• URL: https://github.com/noctisatrae/farsign
• Owner: noctisatrae
• Created: 2023-06-19T21:36:51.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-03T11:55:00.000Z (7 months ago)
• Last Synced: 2024-01-12T01:56:55.057Z (6 months ago)
• Language: TypeScript
• Homepage: https://github.com/noctisatrae/farsign
• Size: 230 KB
• Stars: 19
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-farcaster - noctisatrae/farsign

README

        
# farsign - a package for easy sign-in with Farcaster

![GitHub issues](https://img.shields.io/github/issues/noctisatrae/farsign?style=for-the-badge&logo=github&link=https%3A%2F%2Fgithub.com%2Fnoctisatrae%2Ffarsign%2Fissues)

![GitHub pull requests](https://img.shields.io/github/issues-pr/noctisatrae/farsign?style=for-the-badge&logo=github&link=https%3A%2F%2Fgithub.com%2Fnoctisatrae%2Ffarsign%2Fpulls)

![npm](https://img.shields.io/npm/v/%40farsign%2Fhooks?style=for-the-badge&logo=npm&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40farsign%2Fhooks)

![banner](https://github.com/noctisatrae/farsign/blob/master/assets/banner.jpeg?raw=true)

## What is it used for?

This monorepo contains two packages: `@farsign/hooks` and `@farsign/utils` - the first can be used within any React app to easily implement sign-in with Farcaster and get all the information you need on the signed-in user; the second package contains the basic logic of the authentification that you can use to build your own package to be used with your favorite framework! We're open to PRs and would be very excited to see your work if you implemented something like that :D !

## Getting started! (Thanks for trying it <3)

```bash

npm i @farsign/hooks

```

You should really check the [documentation](https://github.com/noctisatrae/farsign/blob/master/packages/hooks/docs.md) to get an overview of what you have to provide & prepare to make an app on Farcaster. After that, you can play with [our example](https://github.com/noctisatrae/farsign/blob/master/example/src/App.tsx)! If you have any problems, feel free to create an issue!