https://github.com/us3r-network/u3

Social Wallet for Web3
https://github.com/us3r-network/u3

ceramic-network crypto farcaster lens-protocol social wallet web3-dapp

Last synced: 5 days ago
JSON representation

Social Wallet for Web3

• Host: GitHub
• URL: https://github.com/us3r-network/u3
• Owner: us3r-network
• License: mit
• Created: 2023-06-15T09:43:14.000Z (over 1 year ago)
• Default Branch: u3-dev
• Last Pushed: 2024-03-25T03:17:02.000Z (8 months ago)
• Last Synced: 2024-10-26T11:21:26.413Z (19 days ago)
• Topics: ceramic-network, crypto, farcaster, lens-protocol, social, wallet, web3-dapp
• Language: TypeScript
• Homepage: https://u3.xyz
• Size: 8.13 MB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### U3 Monorepo 🚀

This is a monorepo containing code for the U3 project. U3 is a social app that integrates with multiple platforms like Lens and Farcaster.

#### Packages 📦

- `apps/u3` - The main U3 React application 🖥

- `packages/ui` - Shared React UI components 🎨

- `packages/config` - Configuration and environment variables ⚙️

- `packages/utils` - Shared utility functions 🛠

- `packages/social` - Social platform integrations 🤝

#### Getting Started ✨

To install dependencies:

```

yarn install --ignore-engines

```

#### Overview 👀

- The main U3 app code lives in apps/u3. This contains React components, hooks, utils, services etc.

- Shared code is organized into packages under packages/*. The main app imports these packages.

- Key folders in apps/u3/src:

  - components - React components 🖼

  - hooks - Custom hooks for logic ♻️

  - utils - Utility functions 🛠

  - services - API clients 📡

  - types - TypeScript types and interfaces 📜

  - services contains API clients that call backend APIs. 📡

#### Main Technologies 🛠

- React - UI library 📦

- TypeScript - For static typing ⌨️

- React Query - Data fetching and caching 📡

- React Router - Routing and navigation 🗺

- Tailwind CSS - Styling 🎨

- Lens Protocol/Farcaster

#### Social Integrations 🤝

The app integrates deeply with various social platforms:

- Lens Protocol - See src/hooks/social/lens and src/utils/social/lens. 🌐

- Farcaster - See src/components/social/farcaster and src/hooks/social/farcaster. 💬

These integrate via the platforms' JavaScript SDKs and custom React hooks. ♻️

#### License ⚖️

This project is licensed under the MIT license - see LICENSE for more details.

#### Contributing 🤝

See CONTRIBUTING.md to learn how to contribute to this project.