Skip to content

Commit

Permalink
Merge pull request #457 from elbwalker/455-rename-to-sources
Browse files Browse the repository at this point in the history
455 rename to sources
  • Loading branch information
alexanderkirtzel authored Nov 21, 2024
2 parents 6356bf3 + df0637f commit 191c810
Show file tree
Hide file tree
Showing 231 changed files with 3,850 additions and 5,698 deletions.
6 changes: 6 additions & 0 deletions .changeset/wise-games-arrive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@elbwalker/utils': patch
---

clone with circular structures
[#456](https://github.com/elbwalker/walkerOS/issues/456)
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
## Why walkerOS?

walkerOS offers a unified, flexible, and privacy-centric event data collection
platform. It integrates seamlessly with any analytics or storage tool, providing a reliable source of truth for data
teams.
platform. It integrates seamlessly with any analytics or storage tool, providing
a reliable source of truth for data teams.

It is a modular data collection infrastructure, ideal for capturing first-party
events reliably and with privacy in mind. Its vendor-agnostic design ensures
Expand All @@ -33,12 +33,14 @@ seamless integration, giving you complete control over your data.
Lego bricks.
- **Data Quality and Privacy**: Prioritize data integrity and user privacy with
built-in consent management.
- **Flexibility**: Tailored for both server-side and client-side tagging & tracking,
adaptable to your evolving needs.
- **Flexibility**: Tailored for both server-side and client-side tagging &
tracking, adaptable to your evolving needs.

### Target Audience

walkerOS is designed for teams, agencies, and freelancers, who prefer tag management as code and implement tags fast while keeping full control over the whole data collection.
walkerOS is designed for teams, agencies, and freelancers, who prefer tag
management as code and implement tags fast while keeping full control over the
whole data collection.

### Pre-requisites

Expand All @@ -52,13 +54,11 @@ to understand its capabilities fully.

## Package Overview

- **Clients** ([docs](https://www.elbwalker.com/docs/clients/),
[code](./packages/clients/)): For data creation and state management.
- **Sources** ([docs](https://www.elbwalker.com/docs/sources/),
[code](./packages/sources/)): For data creation and state management.
- **Destinations** ([docs](https://www.elbwalker.com/docs/destinations/),
[code](./packages/destinations/)): Initialize, mapp
and share events to third-party tools.
- **Stacks** ([docs](https://www.elbwalker.com/docs/stacks/),
[code](./packages/stacks/)): APIs for event ingestion and processing.
[code](./packages/destinations/)): Initialize, map and share events to
third-party tools.
- **Utils** ([docs](https://www.elbwalker.com/docs/utils/),
[code](./packages/utils/)): Enhance data collection with shared utilities.
- **Docs** ([docs](https://www.elbwalker.com/docs/), [code](./website/docs/)):
Expand All @@ -68,11 +68,15 @@ to understand its capabilities fully.

## Installation

Start collecting data with our [web](https://github.com/elbwalker/walkerOS/tree/main/packages/clients/walkerjs) or [node](https://github.com/elbwalker/walkerOS/tree/main/packages/clients/node) client.
Start collecting data with our
[web](https://github.com/elbwalker/walkerOS/tree/main/packages/sources/walkerjs)
or [node](https://github.com/elbwalker/walkerOS/tree/main/packages/sources/node)
source.

## Contributing

⭐️ Help us grow and star us. See our [Contributing Guidelines](https://www.elbwalker.com/docs/contributing) to get
⭐️ Help us grow and star us. See our
[Contributing Guidelines](https://www.elbwalker.com/docs/contributing) to get
involved.

## Support
Expand Down
1 change: 0 additions & 1 deletion apps/demos/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# walkerOS demos

- [Firebase Stack](./stacks/firebase/)
- [React](./react/)
- [Tagging Website](./tagging/)
10 changes: 5 additions & 5 deletions apps/demos/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ the sign up and pricing discovery behavior.

## Setup and helper function

Using the walkerOS web client with a SPA requires call the `walker run` event on
each router update (see src/app.tsx). We also use a short helper function to
push events to the web client. In this example we're using `console.log` and
`dataLayer` as our destinations (see src/data.ts). In order to activate the
Google GTM destination, functional consent is required (run
Using the walkerOS web source walker.js with a SPA requires call the
`walker run` event on each router update (see src/app.tsx). We also use a short
helper function to push events to the walker.js. In this example we're using
`console.log` and `dataLayer` as our destinations (see src/data.ts). In order to
activate the Google GTM destination, functional consent is required (run
`elb('walker consent', { functional: true });` in the console).

## Trigger page views
Expand Down
2 changes: 1 addition & 1 deletion apps/demos/react/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
content="Web site created using create-react-app"
/>
<script src="https://cdn.tailwindcss.com?plugins=forms,aspect-ratio"></script>
<title>walkerOS web client react example</title>
<title>walkerOS walker.js source react example</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
Expand Down
2 changes: 1 addition & 1 deletion apps/demos/react/src/components/organisms/footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export default function Footer() {
<footer className="bg-gray-50">
<div className="max-w-7xl mx-auto py-12 px-4 overflow-hidden sm:px-6 lg:px-8">
<p className="mt-8 text-center text-base text-gray-400">
walkerOS web client with react.
walkerOS web source walker.js with react.
<br />
Components made by <a href="https://tailwindui.com/">Tailwind UI</a>.
</p>
Expand Down
4 changes: 3 additions & 1 deletion apps/demos/react/src/components/pages/home.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ export default function Home() {
<div className="px-4 sm:px-6 sm:text-center md:max-w-2xl md:mx-auto lg:col-span-6 lg:text-left lg:flex lg:items-center">
<div>
<h1 className="mt-4 text-4xl tracking-tight font-extrabold text-white sm:mt-5 sm:leading-none lg:mt-6 lg:text-5xl xl:text-6xl">
<span className="md:block">walkerOS web client with</span>
<span className="md:block">
walkerOS web source walker.js with
</span>
<span className="text-elbwalker-400 md:block">react</span>
</h1>
<p className="mt-3 text-base text-gray-300 sm:mt-5 sm:text-xl lg:text-lg xl:text-xl">
Expand Down
2 changes: 1 addition & 1 deletion apps/demos/react/src/data/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export function setupAnalytics() {
window.elbLayer = [];
window.elb = elb;

// Initialize the walkerOS web client
// Initialize a walker.js instance
window.walkerjs = Walkerjs({
destinations: {
log: destinationLog,
Expand Down
72 changes: 0 additions & 72 deletions apps/demos/stacks/firebase/.gitignore

This file was deleted.

7 changes: 0 additions & 7 deletions apps/demos/stacks/firebase/README.md

This file was deleted.

17 changes: 0 additions & 17 deletions apps/demos/stacks/firebase/firebase.json

This file was deleted.

Empty file.
39 changes: 0 additions & 39 deletions apps/demos/stacks/firebase/functions/package.json

This file was deleted.

13 changes: 0 additions & 13 deletions apps/demos/stacks/firebase/functions/rollup.config.mjs

This file was deleted.

27 changes: 0 additions & 27 deletions apps/demos/stacks/firebase/functions/src/contracts.ts

This file was deleted.

17 changes: 0 additions & 17 deletions apps/demos/stacks/firebase/functions/src/destinations.ts

This file was deleted.

32 changes: 0 additions & 32 deletions apps/demos/stacks/firebase/functions/src/index.ts

This file was deleted.

Loading

0 comments on commit 191c810

Please sign in to comment.