Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #15 - Improve developer README for openstudioreleases #17

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jmarrec
Copy link
Contributor

@jmarrec jmarrec commented Sep 23, 2024

@jmarrec jmarrec self-assigned this Sep 23, 2024
Comment on lines +118 to +122
For it to work, you need the `firebase-service-account.json` with the private key next to this README.md (Ask the maintainers).

To generate one you will need to go to the [Firebase project Service Accounts settings](https://console.firebase.google.com/u/0/project/osc-downloads/settings/serviceaccounts/adminsdk)

Generate a new private key, and save it to `firebase-service-account.json`. **Note: as soon as you generate a new private key, the old key will stop working, so ask the maintainers to provide it instead**
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@macumber please review this carefully... (also, do you have that json file to share with me?)

Comment on lines 111 to 177
# TODO: explain this

set `.env.prd` for production build No newline at end of file
set `.env.prd` for production build
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • TODO: I don't get that one


### Google Analytics

Set the `GA_ID` in the `.env` file. This is the Measurement ID for the OS App website itself (OS App Git - GA4)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@macumber I am not sure at all this is right. #15 (comment)

openstudioreleases/README.md Show resolved Hide resolved
FIREBASE_MEASUREMENT_ID=
GA_ID=
Copy link
Collaborator

@macumber macumber Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a GA_ID in the .env file, I think you just enter FIREBASE_MEASUREMENT_ID and that links to Google Analytics

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$ cd openstudioreleases && rg GA_ID
src/index.tsx
15:if (config.GA_ID) {
16:  ReactGA.initialize(config.GA_ID);

src/config.tsx
2:  GA_ID: process.env.GA_ID,

src/ga/usePageView.tsx
15:    if (!process.env.GA_ID) 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve README for openstudioreleases
2 participants