From 156611f5874785d40c924e06b6ce4ca47fb5912d Mon Sep 17 00:00:00 2001 From: Leon Morival Date: Sun, 19 Apr 2026 16:01:47 +0200 Subject: [PATCH] feat: readme --- README.md | 72 +++++++++++++++++++++++++++---------------------------- 1 file changed, 35 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 48dd63f..9fe26d1 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,48 @@ -# Welcome to your Expo app 👋 +# Expo Starter -This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app). +Starter Expo avec Firebase Auth et Firestore. -## Get started +## Setup -1. Install dependencies - - ```bash - npm install - ``` - -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: +1. Installe les dépendances ```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. +2. Crée ton fichier d'environnement -## Learn more +```bash +cp .env.example .env +``` -To learn more about developing your project with Expo, look at the following resources: +3. Remplis ton `.env` avec les valeurs de ton projet Firebase -- [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. +```env +EXPO_PUBLIC_FIREBASE_API_KEY= +EXPO_PUBLIC_FIREBASE_AUTH_DOMAIN= +EXPO_PUBLIC_FIREBASE_PROJECT_ID= +EXPO_PUBLIC_FIREBASE_STORAGE_BUCKET= +EXPO_PUBLIC_FIREBASE_MESSAGING_SENDER_ID= +EXPO_PUBLIC_FIREBASE_APP_ID= +``` -## Join the community +4. Dans Firebase Console, active `Authentication > Sign-in method > Email/Password` -Join our community of developers creating universal apps. +5. Crée Firestore dans le même projet Firebase -- [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. +## Lancer le projet + +```bash +npx expo prebuild --clean && npx expo run android +``` + +## Structure utile + +- `app/`: écrans Expo Router +- `components/common/`: composants partagés +- `constants/`: palette, spacing, radius, fonts +- `lib/firebase.ts`: initialisation Firebase +- `lib/firestore.ts`: refs et converters Firestore +- `providers/AuthProvider.tsx`: état d'auth global +- `services/auth.ts`: login, register, logout \ No newline at end of file