Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fostimus/virtual-glovebox
iOS App written with React Native, TailwindCSS connecting to Cloud Firestore. One stop shop for all your driver documentation.
https://github.com/fostimus/virtual-glovebox
Last synced: 22 days ago
JSON representation
iOS App written with React Native, TailwindCSS connecting to Cloud Firestore. One stop shop for all your driver documentation.
- Host: GitHub
- URL: https://github.com/fostimus/virtual-glovebox
- Owner: fostimus
- License: mit
- Created: 2021-02-09T17:14:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-07T09:52:08.000Z (almost 2 years ago)
- Last Synced: 2023-09-25T03:33:17.493Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://virtual-glovebox.fostimus.vercel.app
- Size: 3.16 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# virtual-glovebox
## Run Development Version
1. Download ["Expo Go"](https://apps.apple.com/us/app/expo-go/id982107779) from the App Store
2. Click this link:
## Run Locally
Clone this repository. Once inside `virtual-glovebox`:
1. Run `yarn`
2. Ensure you have `API_KEY` environment variable set in a `.env` file
3. To run the web app, run `yarn next dev`
4. To run iOS app on your iPhone, do the following:
1. Download "Expo Go" from App Store
2. Run `yarn start`
3. In the browser tab that opens, scan the QR code from your iPhone
## Front End
### TailwindCSS
- [React Native Package](https://github.com/vadimdemedes/tailwind-rn)
To change customize style values, edit the appropriate place in `tailwind.config.js`. Then, run `npx create-tailwind-rn` to generate the json file used to set style values throughout the app.
#### Custom Color Class Names
Prefix the following with `bg-` or `text-` to apply the style you want.
- `vgb-primary` - currently a shade of green
- `vgb-secondary` - currently a shade of purple
- `vgb-bg` - used for the app backgroud, currently a light grey
## Build & Deploy
To create a build of the iOS app, run `expo build:ios`
\- This will kick off a build in the expo account that manages the iOS app
To deploy to the Expo server (to update the link for the Expo dev link, the same one under [Run Development Version](<##Run Development Version>)), run `expo publish`
### App Store
Deploying to the iOS App Store _is a big fat pain_. The rough outline/steps are:
1\. Download app bundle file (.ipa) from Expo
2\. Upload to App Store Connect, via Transporter app.
3\. Submit the app for review, over and over again until accepted (there will be feedback why it was rejected, if so)
# To Do
- Use SVGs instead of PNGs for icons. Solution is going to be pretty involved
- Resolve issues from ESLint/DeepSource:
- [forbidden props on components](https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/forbid-component-props.md)
# Known Issues
- [react-native-dotenv with Next v9](https://github.com/goatandsheep/react-native-dotenv/issues/136)