Merge pull request #171 from CriticalMoments/analytics_instructions

Analytics instructions

Author: scosman

README.md

@@ -321,6 +321,7 @@ After the steps above, you’ll have a working version like the demo page. Howev
   - Add actual SaaS functionality!
   - Replace the admin dashboard with real content (`/src/routes/(admin)/account/+page.svelte`).
   - Add API endpoints and database tables as needed to deliver your SaaS product.
+- Analytics: optionally add analytics to your project. [guide](/analytics_docs.md)
 
 ## Community Extensions
 

analytics_docs.md

@@ -0,0 +1,21 @@
+# Adding Analytics
+
+Adding analytics to your SaaS Starter project is optional.
+
+Since each analytics platform has different setup instructions, we've created a guide instead of adding it in code.
+
+### PostHog
+
+- Create a PostHog Account
+- Install PostHog JS Library
+  - Run `npm install posthog-js` in your terminal. This will add PostHog dependencies to your `package.json` and `package-lock.json`.
+- Set Up PostHog
+  - in `src/routes/+layout.svelte` add PostHog to the script section following the [Posthog Svelte Guide](https://posthog.com/docs/libraries/svelte#client-side-setup). Note: ensure you’re logged into PostHog so that the code includes your unique API key automatically.
+- Test analytics
+  - Click around and view a few pages on your site to generate some events. You can view these events in PostHog to ensure tracking is active.
+
+### Google Analytics
+
+Follow the [Google Analytics Guide](https://support.google.com/analytics/answer/9304153?hl=en) to add Google Analytics to your project.
+
+The ideal place to add Google Analytics is in `src/routes/+layout.svelte`.