public inbox for [email protected]
 help / color / mirror / Atom feed
From: Muhammad Rizki <[email protected]>
To: Ammar Faizi <[email protected]>
Cc: Muhammad Rizki <[email protected]>,
	Alviro Iskandar Setiawan <[email protected]>,
	Irvan Malik Azantha <[email protected]>,
	Memet Zx <[email protected]>,
	GNU/Weeb Mailing List <[email protected]>
Subject: [PATCH v1 12/13] chore(README): update README.md
Date: Tue,  3 Oct 2023 09:51:45 +0700	[thread overview]
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>

This commit includes updates to the project instructions and project
structure in the README.md file.

Signed-off-by: Muhammad Rizki <[email protected]>
---
 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


  parent reply	other threads:[~2023-10-03  2:52 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-03  2:51 [PATCH v1 00/13] GNU/Weeb Web Migration to SvelteKit Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 01/13] refactor: migrate: migrate to sveltekit framework Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 02/13] feat(app): add app types file Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 03/13] feat(lib): add API_URL and STORAGE_URL constant variable Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 04/13] feat(lib): add lib functions file Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 05/13] feat(lib): add newly created lib constants variables and functions Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 06/13] feat(lib/functions): add getRepliedMessage() function Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 07/13] feat(lib/functions): add dateFormat() function Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 08/13] feat(components): add <OrganizationMembers/> component Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 09/13] feat(components): add <RecentMessages/> component Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 10/13] feat(routes): add +page.server.ts Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 11/13] feat(routes/page): add +page.svelte Muhammad Rizki
2023-10-03  2:51 ` Muhammad Rizki [this message]
2023-10-05 19:29   ` [PATCH v1 12/13] chore(README): update README.md Ammar Faizi
2023-10-07  5:36     ` Muhammad Rizki
2023-10-03  2:51 ` [PATCH v1 13/13] chore: remove unused files Muhammad Rizki

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox