|
|
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| .vscode | ||
| app | ||
| assets | ||
| components | ||
| containers | ||
| docs | ||
| i18n | ||
| styles | ||
| util | ||
| .env.example | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierrc | ||
| app.json | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
Poker Chips Helper
A mobile application to assist a poker host with determining the denominations and distributions of poker chips.
This applications uses the React Native + Expo framework and by extension is primarily implemented in typescript. These frameworks were chosen for their solid reputation, and ability to easily compile to both major platforms (iOS + Android) with a single code base. Typescript is the default language for new projects with these frameworks, but is also preferred over the javascript alternative as strong typings are very helpful to the developer experience.
Team Members
- David Westgate
- Lakshmi Vyshnavi Vutukuri
- Mantasha Noyela
Building, Running, and Developer Resources
This is an Expo project created with create-expo-app.
Setting Up Environment Variables
To set up your environment variables:
- Copy the example environment variable file to create your own
.envfile:
cp .env.example .env
- Open the
.envfile and add your OpenAI API key:
EXPO_PUBLIC_API_KEY=put-open-ai-key-here
- Save the .env file.
This setup allows you to run the application with your own API credentials, and you can switch models if needed.
VSCode plugins
Get started
-
Install dependencies
npm install -
Start the app
npx expo start
In the output, you'll find options to open the app in a
- development build
- Android emulator
- iOS simulator
- Expo Go, a limited sandbox for trying out app development with Expo
You can start developing by editing the files inside the app directory. This project uses file-based routing.
Android APK build
To create an APK build, use the following
npx expo prebuild
cd android
./gradlew assembleRelease # linux
./gradlew.bat assembleRelease # windows command
Then, see android/app/build/outputs/apk/release/app-release.apk for the output
Learn more
To learn more about developing your project with Expo, look at the following resources:
- Expo documentation: Learn fundamentals, or go into advanced topics with our guides.
- Learn Expo tutorial: Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.