diff --git a/.gitignore b/.gitignore index a0a224e..f31da9b 100644 --- a/.gitignore +++ b/.gitignore @@ -90,6 +90,104 @@ google-services.json *.sqlite *.sqlite3 +# --------------------------- +# Misc +# --------------------------- +*.orig.* +app-example + +# --------------------------- +# Node / Expo / React Native +# --------------------------- +node_modules/ +.expo/ +dist/ +web-build/ +expo-env.d.ts +.metro-health-check* +*.tsbuildinfo + +# Local env files +.env*.local +.env + +# Logs +*.log +npm-debug.* +yarn-debug.* +yarn-error.* + +# macOS +.DS_Store + +# --------------------------- +# Android / React Native native +# Keep /android and /ios ONLY if you commit native code +# Remove these two lines if you want generated native folders ignored +# --------------------------- +.gradle/ +build/ +local.properties +captures/ +.externalNativeBuild/ +.cxx/ +*.aab +*.apk +output-metadata.json +*.hprof +.kotlin/ + +# --------------------------- +# IntelliJ / Android Studio / VS Code +# --------------------------- +*.iml +.idea/ +.vscode/ +misc.xml +deploymentTargetDropDown.xml +render.experimental.xml + +# --------------------------- +# Secrets / signing / platform keys +# --------------------------- +*.jks +*.keystore +*.p8 +*.p12 +*.key +*.pem +*.mobileprovision +google-services.json + +# --------------------------- +# iOS / Android generated native folders +# Ignore these only for Expo managed/prebuild workflow +# Comment them out if you keep native code in repo +# --------------------------- +/android +/ios + +# --------------------------- +# .NET / ASP.NET Core Web API +# --------------------------- +**/bin/ +**/obj/ +**/.vs/ +*.user +*.rsuser +*.suo + +# App settings / local secrets +**/appsettings.Development.json +**/secrets.json + +# EF Core / local DB artifacts +*.db +*.db-shm +*.db-wal +*.sqlite +*.sqlite3 + # --------------------------- # Misc # --------------------------- diff --git a/README.md b/README.md index 48dd63f..e8672d9 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,30 @@ -# Welcome to your Expo app 👋 +# Study Sprint – React Native (Expo) -This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app). +## How to run the source code -## Get started +This explains how to run the app with Expo. -1. Install dependencies +## Requirements - ```bash - npm install - ``` +- Node.js +- npm +- Expo CLI +- Android Studio with an emulator OR Expo Go on a phone -2. Start the app - - ```bash - npx expo start - ``` - -In the output, you'll find options to open the app in a - -- [development build](https://docs.expo.dev/develop/development-builds/introduction/) -- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/) -- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/) -- [Expo Go](https://expo.dev/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](https://docs.expo.dev/router/introduction). - -## Get a fresh project - -When you're ready, run: +## Install dependencies ```bash -npm run reset-project +npm install ``` -This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing. +## Run the app -## Learn more +```bash +npm run start +``` -To learn more about developing your project with Expo, look at the following resources: +After starting expo, you can: +- scan the QR code with Expo Go on your phone, or +- press a in the terminal to open the app in the Android emulator -- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides). -- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web. - -## Join the community - -Join our community of developers creating universal apps. - -- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute. -- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions. +If you use the Android emulator, make sure it is already running before starting the app.