feat: readme
This commit is contained in:
parent
b4933bb865
commit
156611f587
56
README.md
56
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
|
1. Installe les dépendances
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Start the app
|
2. Crée ton fichier d'environnement
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx expo start
|
cp .env.example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
In the output, you'll find options to open the app in a
|
3. Remplis ton `.env` avec les valeurs de ton projet Firebase
|
||||||
|
|
||||||
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
|
```env
|
||||||
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
|
EXPO_PUBLIC_FIREBASE_API_KEY=
|
||||||
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
|
EXPO_PUBLIC_FIREBASE_AUTH_DOMAIN=
|
||||||
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
|
EXPO_PUBLIC_FIREBASE_PROJECT_ID=
|
||||||
|
EXPO_PUBLIC_FIREBASE_STORAGE_BUCKET=
|
||||||
|
EXPO_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
|
||||||
|
EXPO_PUBLIC_FIREBASE_APP_ID=
|
||||||
|
```
|
||||||
|
|
||||||
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
|
4. Dans Firebase Console, active `Authentication > Sign-in method > Email/Password`
|
||||||
|
|
||||||
## Get a fresh project
|
5. Crée Firestore dans le même projet Firebase
|
||||||
|
|
||||||
When you're ready, run:
|
## Lancer le projet
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run reset-project
|
npx expo prebuild --clean && npx expo run android
|
||||||
```
|
```
|
||||||
|
|
||||||
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
|
## Structure utile
|
||||||
|
|
||||||
## Learn more
|
- `app/`: écrans Expo Router
|
||||||
|
- `components/common/`: composants partagés
|
||||||
To learn more about developing your project with Expo, look at the following resources:
|
- `constants/`: palette, spacing, radius, fonts
|
||||||
|
- `lib/firebase.ts`: initialisation Firebase
|
||||||
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
|
- `lib/firestore.ts`: refs et converters Firestore
|
||||||
- [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.
|
- `providers/AuthProvider.tsx`: état d'auth global
|
||||||
|
- `services/auth.ts`: login, register, logout
|
||||||
## 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.
|
|
||||||
Loading…
Reference in New Issue