bsky-app/README.md

37 lines
1.7 KiB
Markdown
Raw Normal View History

2022-06-08 00:50:05 +02:00
# Social App
In-progress social app.
Uses:
- [React Native](https://reactnative.dev)
2022-06-08 22:52:12 +02:00
- [React Native for Web](https://necolas.github.io/react-native-web/)
2022-06-08 01:56:31 +02:00
- [React Navigation](https://reactnative.dev/docs/navigation#react-navigation)
2022-06-09 20:03:25 +02:00
- [MobX](https://mobx.js.org/README.html) and [MobX State Tree](https://mobx-state-tree.js.org/)
- [Async Storage](https://github.com/react-native-async-storage/async-storage)
2022-06-08 00:50:05 +02:00
## Build instructions
- Setup your environment [using the react native instructions](https://reactnative.dev/docs/environment-setup).
2022-06-08 01:56:31 +02:00
- After initial setup:
- `cd ios ; pod install` Installs the React Navigation deps ([info](https://reactnative.dev/docs/navigation#installation-and-setup)).
2022-06-08 00:50:05 +02:00
- To run the iOS simulator: `yarn ios`
- To run the Android simulator: `yarn android`
2022-06-08 22:52:12 +02:00
- To run the Web app: `yarn web`
2022-06-08 00:50:05 +02:00
- Tips
- `npx react-native info` Checks what has been installed.
2022-06-09 23:32:03 +02:00
- Android instructions are a *little* inaccurate but not as much as you might think. I had to manually create a virtual device, then run `yarn android` twice (once to start the emulator and the second time to connect to it).
## TODOs
- API
- Create mock api
- Tests
- Should just try to catch errors on basic load
2022-06-14 05:12:43 +02:00
## Various notes
- ["SSO" flows on mobile](https://developer.okta.com/blog/2022/01/13/mobile-sso)
- Suggests we might want to use `ASWebAuthenticationSession` on iOS
- [react-native-inappbrowser-reborn](https://www.npmjs.com/package/react-native-inappbrowser-reborn) with `openAuth: true` might be worth exploring
- We might even [get rejected by the app store](https://community.auth0.com/t/react-native-ios-app-rejected-on-appstore-for-using-react-native-auth0/36793) if we don't