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 v2 13/14] chore(README): update README.md
Date: Sat, 7 Oct 2023 12:44: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 | 27 +++++++++++++++++++++------
1 file changed, 21 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index edf3c86..9353c3e 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
--
Muhammad Rizki
next prev parent reply other threads:[~2023-10-07 5:45 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-07 5:44 [PATCH v2 00/14] GNU/Weeb Web Migration to SvelteKit Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 01/14] refactor: migrate: migrate to sveltekit framework Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 02/14] feat(layout): add +layout.ts Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 03/14] feat(app): add app types file Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 04/14] feat(lib): add API_URL and STORAGE_URL constant variable Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 05/14] feat(lib): add lib functions file Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 06/14] feat(lib): add newly created lib constants variables and functions Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 07/14] feat(lib/functions): add getRepliedMessage() function Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 08/14] feat(lib/functions): add dateFormat() function Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 09/14] feat(components): add <OrganizationMembers/> component Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 10/14] feat(components): add <RecentMessages/> component Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 11/14] feat(routes): add +page.ts Muhammad Rizki
2023-10-07 5:44 ` [PATCH v2 12/14] feat(routes/page): add +page.svelte Muhammad Rizki
2023-10-07 5:44 ` Muhammad Rizki [this message]
2023-10-07 5:44 ` [PATCH v2 14/14] chore: remove unused files Muhammad Rizki
2023-10-09 21:22 ` [PATCH v2 00/14] GNU/Weeb Web Migration to SvelteKit Ammar Faizi
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