https://github.com/gigouni/peepeepad
PeePeePad, the application to know which dog sleeps upstairs tonight.
https://github.com/gigouni/peepeepad
dogs electron-react-boilerplate firebase personal-project training
Last synced: 2 months ago
JSON representation
PeePeePad, the application to know which dog sleeps upstairs tonight.
- Host: GitHub
- URL: https://github.com/gigouni/peepeepad
- Owner: gigouni
- License: mit
- Created: 2025-02-17T14:20:12.000Z (3 months ago)
- Default Branch: develop
- Last Pushed: 2025-03-05T22:26:43.000Z (3 months ago)
- Last Synced: 2025-03-05T23:25:48.663Z (3 months ago)
- Topics: dogs, electron-react-boilerplate, firebase, personal-project, training
- Language: TypeScript
- Homepage: https://peepeepad-fa20c.web.app/
- Size: 1.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
PeePeePad, the application to know which dog sleeps upstairs tonight https://peepeepad-fa20c.web.app/.
- [1. Install](#1-install)
- [2. Starting Development](#2-starting-development)
- [2.1. Env vars caveats](#21-env-vars-caveats)
- [3. Packaging for Production & deploying to Firebase](#3-packaging-for-production--deploying-to-firebase)
## 1. Install
Install dependencies:
```bash
npm install
```
## 2. Starting Development
Complete the `src/main/constants/sensitive-db.constants.ts` file with your Firebase credentials (values can be found in https://console.firebase.google.com/u/0/project/peepeepad-fa20c/settings/serviceaccounts/databasesecrets)
Start the app in the `dev` environment:
```bash
npm start
```
### 2.1. Env vars caveats
To follow best practices and prevent leaking secrets, I wanted to use a `.env` file to expose some environment variables like the Firebase credentials. Locally, it was okay, but during the packaging process, the Electron wrapping was isolating the app from the "main" world and preventing the use of `process.env`. Some alternatives were investigated, like the Electron IPC and the `exposeToMainWorld()` method to expose the env vars, but after some hours of research, the fun was gone, and I just wanted to release my pain from this issue. The credentials are now in the `src/main/constants/sensitive-db.constants.ts`, and you have to complete it yourself to enjoy the app.
## 3. Packaging for Production & deploying to Firebase
```bash
npm run firebase:deploy
```
Then, launch https://peepeepad-fa20c.web.app/