This still has some rough edges. Needed to duplicate index and ...stories to prevent all assets being eaten by toplevel * route. Also placeholders are broken. Haven't implemented user page.
You can find it deployed to Cloudflare Pages here
Inside of your project, you'll see the following directories and files:
├── public/
│ └── ...
└── src/
├── components/
│ └── ...
└── routes/
└── ...
-
src/routes
: Provides the directory based routing, which can include a hierarchy oflayout.tsx
layout files, andindex.tsx
files as the page. Additionally,index.ts
files are endpoints. Please see the routing docs 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 for more info.
Use the npm run qwik add
command to add other integrations. Some examples of integrations include as a Cloudflare, Netlify or Vercel server, and the Static Site Generator (SSG).
npm run qwik add
Development mode uses Vite's development server. For Qwik during development, the dev
command will also server-side render (SSR) the output. The client-side development modules loaded by the browser.
npm run dev
Note: during dev mode, Vite will request many JS files, which does not represent a Qwik production build.
The preview command will create a production build of the client modules, production build of src/entry.preview.tsx
, and create a local server. The preview server is only for convenience to locally preview a production build, but it should not be used as a production server.
npm run preview
The production build should generate the client and server modules by running both client and server build commands. Additionally, the build command will use Typescript run a type check on the source.
npm run build
This starter site is configured to deploy to Netlify Edge Functions, which means it will be rendered at an edge location near to your users.
The Netlify CLI can be used to preview a production build locally. To do so: First build your site, then to start a local server, run:
- install Netlify CLI globally
npm i -g netlify-cli
- Build your site both ssr and client
npm run build
. - Start a local server with
npm run serve
. In this project,npm run serve
uses thenetlify dev
command to spin up a server that can handle Netlify's Edge Functions locally. - Visit http://localhost:8888/ to check out your site.
You can deploy your site to Netlify 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.
Once your site has been pushed to your Git provider, you can either link it in the Netlify UI or use the CLI. To link your site to a Git provider from the Netlify CLI, run the command:
netlify link
This sets up continuous deployment for your site's repo. Whenever you push new commits to your repo, Netlify starts the build process..
If you wish to deploy from the CLI rather than using Git, you can use the command:
netlify deploy --build
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.
Add --prod
flag to deploy to production.
Cloudflare's wrangler CLI can be used to preview a production build locally. To start a local server, run:
npm run serve
Then visit http://localhost:8787/
Cloudflare Pages are deployable through their Git provider integrations.
If you don't already have an account, then create a Cloudflare account here. Next go to your dashboard and follow the Cloudflare Pages deployment guide.
Within the projects "Settings" for "Build and deployments", the "Build command" should be npm run build
, and the "Build output directory" should be set to dist
.
Cloudflare's wrangler CLI can be used to preview a production build locally. To start a local server, run:
npm run serve
Then visit http://localhost:8787/
Cloudflare Pages are deployable through their Git provider integrations.
If you don't already have an account, then create a Cloudflare account here. Next go to your dashboard and follow the Cloudflare Pages deployment guide.
Within the projects "Settings" for "Build and deployments", the "Build command" should be npm run build
, and the "Build output directory" should be set to dist
.
Cloudflare's wrangler CLI can be used to preview a production build locally. To start a local server, run:
npm run serve
Then visit http://localhost:8787/
Cloudflare Pages are deployable through their Git provider integrations.
If you don't already have an account, then create a Cloudflare account here. Next go to your dashboard and follow the Cloudflare Pages deployment guide.
Within the projects "Settings" for "Build and deployments", the "Build command" should be npm run build
, and the "Build output directory" should be set to dist
.
This app has a minimal Express server implementation. After running a full build, you can preview the build using the command:
npm run serve
Then visit http://localhost:8080/