Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/limjiechao/qwik-oidc-context
Created with CodeSandbox
https://github.com/limjiechao/qwik-oidc-context
Last synced: about 2 months ago
JSON representation
Created with CodeSandbox
- Host: GitHub
- URL: https://github.com/limjiechao/qwik-oidc-context
- Owner: limjiechao
- Created: 2023-11-01T23:36:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-02T10:45:09.000Z (about 1 year ago)
- Last Synced: 2023-11-03T00:37:26.851Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://codesandbox.io/p/github/limjiechao/qwik-oidc-context
- Size: 137 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Qwik City App ⚡️
- [Qwik Docs](https://qwik.builder.io/)
- [Discord](https://qwik.builder.io/chat)
- [Qwik GitHub](https://github.com/BuilderIO/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [Vite](https://vitejs.dev/)
---
## Project Structure
This project is using Qwik with
[QwikCity](https://qwik.builder.io/qwikcity/overview/). QwikCity is just a 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:
```
├── 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.builder.io/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 `npm run 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.builder.io/qwikcity/guides/static-site-generation/).
```shell
npm run qwik add # or `yarn qwik add`
```
## 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`
```
> Note: during dev mode, Vite may request a significant number of `.js` files.
> This does not represent a Qwik production build.
## Preview
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
npm run preview # or `yarn preview`
```
## Production
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.
```shell
npm run build # or `yarn build`
```