This project is using Qwik with QwikCity. 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:
├── public/
│ └── ...
└── src/
├── components/
│ └── ...
└── routes/
└── ...
-
src/routes
: Provides the directory-based routing, which can include a hierarchy oflayout.tsx
layout files, and anindex.tsx
file 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 additional integrations. Some examples of integrations includes: Cloudflare, Netlify or Express Server, and the Static Site Generator (SSG).
npm run qwik add # or `yarn qwik add`
Development mode uses Vite's development server. The dev
command will server-side render (SSR) the output during development.
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.
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 preview a production build locally and should not be used as a production server.
npm run preview # or `yarn preview`
The production build will generate client and server modules by running both client and server build commands. The build command will use Typescript to run a type check on the source code.
npm run build # or `yarn build`
This app has a minimal Fastify server implementation. After running a full build, you can preview the build using the command:
npm run serve
Then visit http://localhost:3000/
This guide provides step-by-step instructions on setting up a Kind (Kubernetes in Docker) cluster for your development environment. Kind allows you to run Kubernetes clusters in Docker containers, which is ideal for local testing and development.
Before you begin, ensure that you have Python and Ansible installed on your machine. These tools are necessary for creating the virtual environment, installing dependencies, and configuring the cluster.
Start by creating an isolated Python environment to manage the project's dependencies:
python -m venv .venv
Activate the virtual environment to use it for the subsequent operations:
source .venv/bin/activate
Ensure that you have the latest version of pip, the Python package manager:
pip install --upgrade pip
Install the required Python packages listed in the project's requirements.txt
file:
pip install -r kind/requirements.txt
Install the necessary Ansible collections for cluster configuration as specified in the project's YAML file:
ansible-galaxy collection install -r kind/ansible-requirements.yaml
Set up the public environment variables by creating and editing a .env
file in the specified directory. Adjust the variables as needed for your setup:
- Location:
k8s/patches/dev/.env
- Example Content:
ORIGIN=https://localhost:30443
Similarly, set up the private environment variables by creating and editing a .env.local
file. These variables should be kept secure and not exposed publicly:
- Location:
k8s/patches/dev/.env.local
- Example Content:
SURREALDB_USER=root SURREALDB_PASS=toor
Use the provided shell script to create a new Kind cluster with the specified configuration:
./create-cluster.sh
Finally, apply the necessary Kubernetes patches to your cluster to complete the setup:
./deploy-to-cluster.sh
Once the Kubernetes patches have been applied and the Kind cluster setup is complete, you can access the deployed container through your web browser:
- For HTTP access, navigate to: http://localhost:30080
- For HTTPS access, navigate to: https://localhost:30443