From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on gnuweeb.org X-Spam-Level: X-Spam-Status: No, score=-1.2 required=5.0 tests=ALL_TRUSTED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,URIBL_BLOCKED, URIBL_DBL_BLOCKED_OPENDNS autolearn=ham autolearn_force=no version=3.4.6 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gnuweeb.org; s=default; t=1696301559; bh=dNlIVkzXRaMncy114Z119yUP/GSsdi4EYTfIzRSi4Ro=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=cT5ZUZlNg3JTyU5RH5xgmoLuDX7Tjbt5qKFINwUu3eWPl0jY2eqbcJc1AO62pEKbI Ebi5zPlEwnsGFSIYQ1LWr7xUWaJEPPANLqUcV8SMBJpddwOhzldFCHVgGulB0Z/kxi E7+hBhDSw8K+SOnyZZCMrKIHaAF99lX0utWOzkpog9zDZ2CMJi+zHTwQrfAbrTaLM7 2OQx4eOJDxN1FcZkXU65g49rrz41Nat2hTyAlwuBLnVpgfxlfOS8ZE9zLOkQm0YSXx YN1XG85LPHzBEeJkCHHKym2PFrY/3STPsLCp6aAOuTYGiBcGF44zXDfaGi8q9xNzO4 G+5t3XKzlU4hg== Received: from localhost.localdomain (unknown [175.158.50.50]) by gnuweeb.org (Postfix) with ESMTPSA id 7265224B8D9; Tue, 3 Oct 2023 09:52:37 +0700 (WIB) From: Muhammad Rizki To: Ammar Faizi Cc: Muhammad Rizki , Alviro Iskandar Setiawan , Irvan Malik Azantha , Memet Zx , GNU/Weeb Mailing List Subject: [PATCH v1 12/13] chore(README): update README.md Date: Tue, 3 Oct 2023 09:51:45 +0700 Message-Id: <20231003025146.1557-13-kiizuha@gnuweeb.org> X-Mailer: git-send-email 2.34.1.windows.1 In-Reply-To: <20231003025146.1557-1-kiizuha@gnuweeb.org> References: <20231003025146.1557-1-kiizuha@gnuweeb.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: This commit includes updates to the project instructions and project structure in the README.md file. Signed-off-by: Muhammad Rizki --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index edf3c86..861add0 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,45 @@ # GNU/Weeb's Landing Page -GNU/Weeb's simple landing page. +GNU/Weeb's landing page made with svelte/kit. ## Project Structure ``` -/ - index.html (Main page) - - style.css (Tailwind CSS) +/ - src/ (App source) + - lib/ (App library) + - routes/ (App routes) + - components/ (App UI components) + - app.css (App CSS styles) + - app.d.ts (App types) + - app.html (App root HTML) - package.json (Dev dependencies) - *package-lock.json (npm lockfile) - static/ (Static files) - favicon.ico (Favicon) - **dist/ (Build directory) - - build.js (Build script) + - **.svelte-kit/ (Compiled svelte/kit directory) - .gitignore (Git ignore) + . .editorconfig (IDE/Editor config file) + - .eslintignore (ES lint ignore file) + - .eslintrc.cjs (ES lint config file) + - .prettierignore (Prettier ignore file) + - .prettierrc (Prettier config file) + - postcss.config.js (PostCSS config file) + - svelte.config.js (Svelte config file) + - tailwind.config.js (Tailwind config file) + - tsconfig.json (TypeScript compiler config file) + - vite.config.ts (Vite config file) /** Legend: * (*) => Only available after npm install - * (**) => Only available after npm build + * (**) => Only available after npm run build */ ``` ## Development -> You will need `nodejs` (minimum version: 16) and `npm` package to run the dev server locally +> You will need `nodejs` (minimum version: 16), `TypeScript` (minimum version: 5) and `npm` package to run the dev server locally. ### Installing dependencies @@ -52,6 +67,15 @@ npm run build This will copy all the required files into the `dist` directory. +## Production Build Server + +To run the production build node server, issue this command: + +```bash +node dist +# Listening on 0.0.0.0:3000 +``` + ## License BSD 3-Clause License. -- Muhammad Rizki