From 421ef253738a98f53f1cf8a82fabf01544d19e45 Mon Sep 17 00:00:00 2001
From: Mauricio Siu <47042324+Siumauricio@users.noreply.github.com>
Date: Sun, 30 Jun 2024 19:51:46 -0600
Subject: [PATCH] feat: add readme qwik

---
 qwik-simple/README.md | 77 +++++++++++--------------------------------
 1 file changed, 19 insertions(+), 58 deletions(-)

diff --git a/qwik-simple/README.md b/qwik-simple/README.md
index bc53f27..a59a9d5 100644
--- a/qwik-simple/README.md
+++ b/qwik-simple/README.md
@@ -1,65 +1,26 @@
-# Qwik City App ⚡️
+# Qwikjs Example
 
-- [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/)
+This repository contains an example of Qwikjs application that is deployed on Dokploy.
 
----
 
-## Project Structure
+1. **Use Git Provider in Your Application**:
+   - Repository: `https://github.com/Dokploy/examples.git`
+   - Branch: `main`
+   - Build path: `/qwik-simple`
 
-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.
+2. **Add Environment Variables**:
+- Navigate to the "Environments" tab and add the following variable:
+   ```plaintext
+   NIXPACKS_START_CMD="pnpm run preview"
+   ```
 
-Inside your project, you'll see the following directory structure:
+3. **Click on Deploy**:
+   - Deploy your application by clicking the deploy button.
 
-```
-├── public/
-│   └── ...
-└── src/
-    ├── components/
-    │   └── ...
-    └── routes/
-        └── ...
-```
+4. **Generate a Domain**:
+    - Click on generate domain button.
+    - A new domain will be generated for you.
+    - You can use this domain to access your application.
 
-- `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 `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)](https://qwik.dev/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/). The `dev` command will server-side render (SSR) the output during development.
-
-```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 preview a production build locally and 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. The build command will use Typescript to run a type check on the source code.
-
-```shell
-npm run build # or `yarn build`
-```
+    
+If you need further assistance, join our [Discord server](https://discord.com/invite/2tBnJ3jDJc).