Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dylsteck/litecast
A beautiful yet simple Farcaster client
https://github.com/dylsteck/litecast
expo farcaster farcasterkit neynar react-native
Last synced: 8 days ago
JSON representation
A beautiful yet simple Farcaster client
- Host: GitHub
- URL: https://github.com/dylsteck/litecast
- Owner: dylsteck
- Created: 2023-12-04T04:59:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-30T19:57:55.000Z (7 months ago)
- Last Synced: 2024-11-25T18:14:15.066Z (17 days ago)
- Topics: expo, farcaster, farcasterkit, neynar, react-native
- Language: TypeScript
- Homepage:
- Size: 703 KB
- Stars: 54
- Watchers: 2
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-farcaster - Litecast
- awesome-farcaster-dev - `litecast`
- awesome-farcaster-dev - `litecast`
README
# Litecast ✍️
A beautiful yet simple Farcaster client
Built as an open source example for FarcasterKit x Neynar, as well as part of [dwr.eth's mobile client bounty](https://warpcast.com/dwr.eth/0x5727a985)
### Built with
- [Expo](https://expo.dev)
- FarcasterKit's [farcasterkit-react-native](https://www.npmjs.com/package/farcasterkit-react-native)
- Neynar's [react-native-signin](https://www.npmjs.com/package/@neynar/react-native-signin)
### How to run
1. Set up the app locally
- `git clone https://github.com/dylsteck/litecast`
- `cd litecast && yarn install`
2. Set environment variables
- Copy `.env.example` to a new `.env` file and add your `NEYNAR_API_KEY`
- In `constants.ts`, the `API_URL` value is for FarcasterKit's API, which has routes to get/receive the signer and post casts to Neynar. Don't change this value you're running the FarcasterKit API locally, but if not change the value to `http://api.farcasterkit.com`
- Set the same values you have in your `.env` file in `eas.json` under the env sections for development and preview
3. Create Expo project
- To run the app locally, you'll need to create an account at `https://expo.dev`, then create a new project
- Once you've created a project, run `npm install --global eas-cli && eas init --id [YOUR PROJECT ID]` to overwrite the existing project with your own
4. Run by calling `yarn start`
### Todos
Note: These are just a few todos on the top of my mind that would get the app to v1.0(full feature parity with the mockups below), but I'm sure smaller tasks and larger ideas will come to mind as well.
- [] Further style the cast and thread components
- [] Add search
- [] Add following channels(via search)
- [] Add user pages
- [] Add more of the backend logic to [farcasterkit-react-native](https://www.npmjs.com/package/farcasterkit-react-native) (not much left to move over)
- [] Add logout capabilities
### Mockups
Here are some mockups to further showcase where the app is headed -- huge shoutout again to [Sirsu](https://warpcast.com/sirsu) for the amazing designs 🙌
| Login | Home |
| :------------------------------------------------: | :-----------------------------------------------: |
|  |  |
| Search | Reply |
| :-------------------------------------------------: | :------------------------------------------------: |
|  |  |