This is a monorepo containing code for the U3 project. U3 is a social app that integrates with multiple platforms like Lens and Farcaster.
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 ๐ค
To install dependencies:
yarn install --ignore-engines
-
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. ๐ก
- React - UI library ๐ฆ
- TypeScript - For static typing โจ๏ธ
- React Query - Data fetching and caching ๐ก
- React Router - Routing and navigation ๐บ
- Tailwind CSS - Styling ๐จ
- Lens Protocol/Farcaster
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. โป๏ธ
This project is licensed under the MIT license - see LICENSE for more details.
See CONTRIBUTING.md to learn how to contribute to this project.