|
1 | | -# Qwik City App ⚡️ |
| 1 | +# Qwik Insights |
2 | 2 |
|
3 | | -- [Qwik Docs](https://qwik.dev/) |
4 | | -- [Discord](https://qwik.dev/chat) |
5 | | -- [Qwik GitHub](https://github.com/QwikDev/qwik) |
6 | | -- [@QwikDev](https://twitter.com/QwikDev) |
7 | | -- [Vite](https://vitejs.dev/) |
| 3 | +## Local Development |
8 | 4 |
|
9 | | ---- |
10 | | - |
11 | | -## Project Structure |
12 | | - |
13 | | -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. |
14 | | - |
15 | | -Inside your project, you'll see the following directory structure: |
| 5 | +Ensure you have `.env.local` set up like so: |
16 | 6 |
|
17 | 7 | ``` |
18 | | -├── public/ |
19 | | -│ └── ... |
20 | | -└── src/ |
21 | | - ├── components/ |
22 | | - │ └── ... |
23 | | - └── routes/ |
24 | | - └── ... |
25 | | -``` |
26 | | - |
27 | | -- `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. |
28 | | - |
29 | | -- `src/components`: Recommended directory for components. |
30 | | - |
31 | | -- `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. |
32 | | - |
33 | | -## Add Integrations and deployment |
34 | | - |
35 | | -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/). |
36 | | - |
37 | | -```shell |
38 | | -pnpm qwik add # or `yarn qwik add` |
| 8 | +PRIVATE_LIBSQL_DB_URL=ws://127.0.0.1:8080 |
| 9 | +PRIVATE_LIBSQL_DB_API_TOKEN=(none) |
| 10 | +PRIVATE_AUTH_BASE_API=/api/auth |
39 | 11 | ``` |
40 | 12 |
|
41 | | -## Development |
42 | | - |
43 | | -Development mode uses [Vite's development server](https://vitejs.dev/). During development, the `dev` command will server-side render (SSR) the output. |
44 | | - |
45 | | -```shell |
46 | | -npm start # or `yarn start` |
| 13 | +```sh |
| 14 | +npm run db.local |
47 | 15 | ``` |
48 | 16 |
|
49 | | -> Note: during dev mode, Vite may request a significant number of `.js` files. This does not represent a Qwik production build. |
50 | | -
|
51 | | -## Preview |
| 17 | +in another window |
52 | 18 |
|
53 | | -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. |
54 | | - |
55 | | -```shell |
56 | | -pnpm preview # or `yarn preview` |
| 19 | +```sh |
| 20 | +npm run db.migrate |
57 | 21 | ``` |
58 | 22 |
|
59 | | -## Production |
| 23 | +### Local Development with |
60 | 24 |
|
61 | | -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. |
| 25 | +If you would like to run the application with production database set up `.env.local` like so: |
62 | 26 |
|
63 | | -```shell |
64 | | -pnpm build # or `yarn build` |
65 | 27 | ``` |
66 | | - |
67 | | -## Netlify |
68 | | - |
69 | | -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. |
70 | | - |
71 | | -### Local development |
72 | | - |
73 | | -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: |
74 | | - |
75 | | -1. Install Netlify CLI globally `npm i -g netlify-cli`. |
76 | | -2. Build your site with both ssr and static `pnpm build`. |
77 | | -3. Start a local server with `pnpm serve`. |
78 | | - In this project, `pnpm serve` uses the `netlify dev` command to spin up a server that can handle Netlify's Edge Functions locally. |
79 | | -4. Visit [http://localhost:8888/](http://localhost:8888/) to check out your site. |
80 | | - |
81 | | -### Edge Functions Declarations |
82 | | - |
83 | | -[Netlify Edge Functions declarations](https://docs.netlify.com/edge-functions/declarations/) |
84 | | -can be configured to run on specific URL patterns. Each edge function declaration associates |
85 | | -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. |
86 | | - |
87 | | -This is useful to determine if a page response should be Server-Side Rendered (SSR) or |
88 | | -if the response should use a static-site generated (SSG) `index.html` file instead. |
89 | | - |
90 | | -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. |
91 | | - |
92 | | -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: |
93 | | - |
94 | | -```toml |
95 | | -[[edge_functions]] |
96 | | - path = "/admin" |
97 | | - function = "auth" |
98 | | -``` |
99 | | - |
100 | | -### Addition Adapter Options |
101 | | - |
102 | | -Netlify-specific option fields that can be passed to the adapter options: |
103 | | - |
104 | | -- `excludedPath` this option accepts a `string` glob pattern that represents which path pattern should not go through the generated Edge Functions. |
105 | | - |
106 | | -### Deployments |
107 | | - |
108 | | -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. |
109 | | - |
110 | | -#### Deploying via Git |
111 | | - |
112 | | -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: |
113 | | - |
114 | | -```shell |
115 | | -netlify link |
116 | | -``` |
117 | | - |
118 | | -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.. |
119 | | - |
120 | | -#### Deploying manually via the CLI |
121 | | - |
122 | | -If you wish to deploy from the CLI rather than using Git, you can use the command: |
123 | | - |
124 | | -```shell |
125 | | -netlify deploy --build |
| 28 | +PRIVATE_LIBSQL_DB_URL=libsql://qwik-bundalyzer-mhevery.turso.io |
| 29 | +PRIVATE_LIBSQL_DB_API_TOKEN=<API_TOKEN> |
| 30 | +PRIVATE_AUTH_SECRET=<AUTH_SECRET> |
| 31 | +PRIVATE_AUTH_BASE_API=/api/auth |
126 | 32 | ``` |
127 | 33 |
|
128 | | -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. |
| 34 | +You need two pieces of information: |
129 | 35 |
|
130 | | -Add `--prod` flag to deploy to production. |
| 36 | +- `AUTH_SECRET`: |
| 37 | + - run `turso auth login` to authenticate |
| 38 | + - run `turso auth api-tokens mint insights-<you-username>` to get a new token |
| 39 | +- `API_TOKEN`: This is needed for using github as authentication. See: https://qwik.dev/docs/integrations/authjs/#github |
0 commit comments