Skip to content

Commit

Permalink
docs(readme.md): run project
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonCrk committed Nov 23, 2023
1 parent 8201847 commit 7c3c910
Show file tree
Hide file tree
Showing 6 changed files with 100 additions and 0 deletions.
100 changes: 100 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# COMO EJECUTAR LA APP

## Firebase

1. Debe crear un archivo `.env` en la raíz del proyecto.

2. Copie el contenido del archivo `.env.example` y páselo al archivo `.env` que ha creado.

El `.env` debería verse asi:

```py
# API
VITE_REACT_BASE_API_URL=

# FIREBASE
VITE_REACT_FIREBASE_API_KEY=
VITE_REACT_FIREBASE_AUTH_DOMAIN=
VITE_REACT_FIREBASE_PROJECT_ID=
VITE_REACT_FIREBASE_STORAGE_BUCKET=
VITE_REACT_FIREBASE_MESSAGING_SENDER_ID=
VITE_REACT_FIREBASE_APP_ID=
VITE_REACT_FIREBASE_KEY_PAIR_MESSAGING=
```

4. En la carpeta `public` debe crear un archivo llamado `firebase-messaging-sw.js`.

5. Copie el contenido del archivo `firebase-messaging-example.js` y páselo al archivo `firebase-messaging-sw.js` pero quitando los `//` que se encuentran.

El `firebase-messaging-sw.js` Debería verse asi:

```js
importScripts(
'https://www.gstatic.com/firebasejs/10.4.0/firebase-app-compat.js'
)
importScripts(
'https://www.gstatic.com/firebasejs/10.4.0/firebase-messaging-compat.js'
)

const firebaseConfig = {
apiKey: '',
authDomain: '',
projectId: '',
storageBucket: '',
messagingSenderId: '',
appId: '',
}

const app = firebase.initializeApp(firebaseConfig)
const messaging = firebase.messaging(app)

messaging.onBackgroundMessage(payload => {
const notificationTitle = payload.notification.title
const notificationOptions = {
body: payload.notification.body,
}

return self.registration.showNotification(
notificationTitle,
notificationOptions
)
})

```

6. __IMPORTANTE__: Necesito que ingrese a este [link](https://firebase.google.com/?hl=es) y cree un proyecto de firebase

7. Luego de crear el proyecto de firebase necesito que ingrese a esta sección

![Project config page](docs/firebase-project-config-page.png)

8. Registra una app que sea de tipo web y cuando lo tenga listo vuelva a la pestaña que señale en el punto 7 y vaya a lo más bajo de la pagina y se encontrara con esto

![Firebase config](docs/firebase-config.png)

7. Con los datos que tiene usted ahi cópielos tanto en el `.env` como en el `firebase-messaging-sw.js`

8. Aun falta un valor que se encuentra en el `.env` que es el siguiente:

```py
VITE_REACT_FIREBASE_KEY_PAIR_MESSAGING=
```

9. Para obtenerlo hay que buscar en esta pestaña del firebase:

![Alt text](docs\firebase-cloud-messaging-tab.png)

10. Debe de tener esto habilitado (si no sabe como hacerlo puede buscar en youtube):

![Alt text](docs\firebase-habilitado-2.png)

11. Mas abajo debería den encontrar la clase que necesita y con eso ya estaría.

![Alt text](docs\firebase-key-pair.png)

12. Para terminar debe tener NodeJS (si es la ultima version mejor) y ejecute los siguientes comandos:

```cmd
npm install
npm run dev
```
Binary file added docs/firebase-cloud-messaging-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/firebase-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/firebase-habilitado-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/firebase-key-pair.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/firebase-project-config-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7c3c910

Please sign in to comment.