docs(insights): Add developer docs (#6957)

packages/insights/README.md

@@ -1,130 +1,39 @@
-# Qwik City App ⚡️
+# Qwik Insights
 
-- [Qwik Docs](https://qwik.dev/)
-- [Discord](https://qwik.dev/chat)
-- [Qwik GitHub](https://github.com/QwikDev/qwik)
-- [@QwikDev](https://twitter.com/QwikDev)
-- [Vite](https://vitejs.dev/)
+## Local Development
 
----
-
-## Project Structure
-
-This project is using Qwik with [QwikCity](https://qwik.dev/qwikcity/overview/). QwikCity is just an extra set of tools on top of Qwik to make it easier to build a full site, including directory-based routing, layouts, and more.
-
-Inside your project, you'll see the following directory structure:
+Ensure you have `.env.local` set up like so:
 
 ```
-├── public/
-│   └── ...
-└── src/
-    ├── components/
-    │   └── ...
-    └── routes/
-        └── ...
-```
-
-- `src/routes`: Provides the directory based routing, which can include a hierarchy of `layout.tsx` layout files, and an `index.tsx` file as the page. Additionally, `index.ts` files are endpoints. Please see the [routing docs](https://qwik.dev/qwikcity/routing/overview/) for more info.
-
-- `src/components`: Recommended directory for components.
-
-- `public`: Any static assets, like images, can be placed in the public directory. Please see the [Vite public directory](https://vitejs.dev/guide/assets.html#the-public-directory) for more info.
-
-## Add Integrations and deployment
-
-Use the `pnpm qwik add` command to add additional integrations. Some examples of integrations include: Cloudflare, Netlify or Express server, and the [Static Site Generator (SSG)](https://qwik.dev/qwikcity/guides/static-site-generation/).
-
-```shell
-pnpm qwik add # or `yarn qwik add`
+PRIVATE_LIBSQL_DB_URL=ws://127.0.0.1:8080
+PRIVATE_LIBSQL_DB_API_TOKEN=(none)
+PRIVATE_AUTH_BASE_API=/api/auth
 ```
 
-## Development
-
-Development mode uses [Vite's development server](https://vitejs.dev/). During development, the `dev` command will server-side render (SSR) the output.
-
-```shell
-npm start # or `yarn start`
+```sh
+npm run db.local
 ```
 
-> Note: during dev mode, Vite may request a significant number of `.js` files. This does not represent a Qwik production build.
-
-## Preview
+in another window
 
-The preview command will create a production build of the client modules, a production build of `src/entry.preview.tsx`, and run a local server. The preview server is only for convenience to locally preview a production build, and it should not be used as a production server.
-
-```shell
-pnpm preview # or `yarn preview`
+```sh
+npm run db.migrate
 ```
 
-## Production
+### Local Development with
 
-The production build will generate client and server modules by running both client and server build commands. Additionally, the build command will use Typescript to run a type check on the source code.
+If you would like to run the application with production database set up `.env.local` like so:
 
-```shell
-pnpm build # or `yarn build`
 ```
-
-## Netlify
-
-This starter site is configured to deploy to [Netlify Edge Functions](https://docs.netlify.com/edge-functions/overview/), which means it will be rendered at an edge location near to your users.
-
-### Local development
-
-The [Netlify CLI](https://docs.netlify.com/cli/get-started/) can be used to preview a production build locally. To do so: First build your site, then to start a local server, run:
-
-1. Install Netlify CLI globally `npm i -g netlify-cli`.
-2. Build your site with both ssr and static `pnpm build`.
-3. Start a local server with `pnpm serve`.
-   In this project, `pnpm serve` uses the `netlify dev` command to spin up a server that can handle Netlify's Edge Functions locally.
-4. Visit [http://localhost:8888/](http://localhost:8888/) to check out your site.
-
-### Edge Functions Declarations
-
-[Netlify Edge Functions declarations](https://docs.netlify.com/edge-functions/declarations/)
-can be configured to run on specific URL patterns. Each edge function declaration associates
-one site path pattern with one function to execute on requests that match the path. A single request can execute a chain of edge functions from a series of declarations. A single edge function can be associated with multiple paths across various declarations.
-
-This is useful to determine if a page response should be Server-Side Rendered (SSR) or
-if the response should use a static-site generated (SSG) `index.html` file instead.
-
-By default, the Netlify Edge adaptor will generate a `.netlify/edge-middleware/manifest.json` file, which is used by the Netlify deployment to determine which paths should, and should not, use edge functions.
-
-To override the generated manifest, you can [add a declaration](https://docs.netlify.com/edge-functions/declarations/#add-a-declaration) to the `netlify.toml` using the `[[edge_functions]]` config. For example:
-
-```toml
-[[edge_functions]]
-  path = "/admin"
-  function = "auth"
-```
-
-### Addition Adapter Options
-
-Netlify-specific option fields that can be passed to the adapter options:
-
-- `excludedPath` this option accepts a `string` glob pattern that represents which path pattern should not go through the generated Edge Functions.
-
-### Deployments
-
-You can [deploy your site to Netlify](https://docs.netlify.com/site-deploys/create-deploys/) either via a Git provider integration or through the Netlify CLI. This starter site includes a `netlify.toml` file to configure your build for deployment.
-
-#### Deploying via Git
-
-Once your site has been pushed to your Git provider, you can either link it [in the Netlify UI](https://app.netlify.com/start) or use the CLI. To link your site to a Git provider from the Netlify CLI, run the command:
-
-```shell
-netlify link
-```
-
-This sets up [continuous deployment](https://docs.netlify.com/site-deploys/create-deploys/#deploy-with-git) for your site's repo. Whenever you push new commits to your repo, Netlify starts the build process..
-
-#### Deploying manually via the CLI
-
-If you wish to deploy from the CLI rather than using Git, you can use the command:
-
-```shell
-netlify deploy --build
+PRIVATE_LIBSQL_DB_URL=libsql://qwik-bundalyzer-mhevery.turso.io
+PRIVATE_LIBSQL_DB_API_TOKEN=<API_TOKEN>
+PRIVATE_AUTH_SECRET=<AUTH_SECRET>
+PRIVATE_AUTH_BASE_API=/api/auth
 ```
 
-You must use the `--build` flag whenever you deploy. This ensures that the Edge Functions that this starter site relies on are generated and available when you deploy your site.
+You need two pieces of information:
 
-Add `--prod` flag to deploy to production.
+- `AUTH_SECRET`:
+  - run `turso auth login` to authenticate
+  - run `turso auth api-tokens mint insights-<you-username>` to get a new token
+- `API_TOKEN`: This is needed for using github as authentication. See: https://qwik.dev/docs/integrations/authjs/#github

packages/qwik-labs/package.json

@@ -17,9 +17,6 @@
     "vite": "5.3.5",
     "zod": "3.22.4"
   },
-  "peerDependencies": {
-    "zod": "3.22.4"
-  },
   "engines": {
     "node": ">=16.8.0 <18.0.0 || >=18.11"
   },
@@ -40,6 +37,9 @@
     "vite"
   ],
   "main": "./lib/index.qwik.mjs",
+  "peerDependencies": {
+    "zod": "3.22.4"
+  },
   "private": true,
   "qwik": "./lib/index.qwik.mjs",
   "scripts": {