shifting to version v1.1.0 is cool.

- docs updated and fixed. - ui updated. - logo changed.
OurCodeBase · Sep 20, 2024 · 70cefa0 · 70cefa0
1 parent f432dce
commit 70cefa0
Show file tree

Hide file tree

Showing 8 changed files with 142 additions and 116 deletions.
diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
@@ -3,17 +3,21 @@ export default {
   base: '/gen3-express/',
   title: "Gen3 Express",
   head: [['meta', { name: 'google-site-verification', content: '8ITIfF1pu9VrQOnXrnDnYZqCILQjm5wgdxYLt056ApI' }]],
-  description: "A gen3 tool to generate get started express app.",
+  description: "A gen3 tool to generate express app boilerplate.",
   themeConfig: {
     siteTitle: "Gen3 Express",
-    logo: "https://www.cdnlogo.com/logos/h/71/hashnode.svg",
-    socialLinks: [ 
+    logo: "/icons/logo.blue.png",
+    socialLinks: [
       { icon: "github", link: "https://github.com/OurCodeBase" },
       { icon: "instagram", link: "https://instagram.com/aspandapo" },
       { icon: "youtube", link: "https://m.youtube.com/@OurCodeBase" }
     ],
+    nav: [
+      { text: "History", link: "https://github.com/OurCodeBase/gen3-express/commits/main/" },
+      { text: "Changelogs", link: "/changelogs" }
+    ],
     footer: {
-      copyright: "Copyright © 2024-present OurCodeBase",
+      copyright: "All Right Reserved @OurCodeBase",
     },
   }
 };
diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
@@ -1,5 +1,4 @@
-@import url(https://fonts.googleapis.com/css?family=Space+Mono:regular,italic,700,700italic);
-@import url(https://fonts.googleapis.com/css?family=Space+Grotesk:regular,italic,700,700italic);
+@import url('https://fonts.googleapis.com/css2?family=Sora:[email protected]&family=Space+Mono:ital,wght@0,400;0,700;1,400;1,700&display=swap');
 
 :root {
   --vp-c-brand: #ff7340;
@@ -11,12 +10,8 @@
 
   --vp-c-sponsor: #fd1d7c;
 
-  /* Typography */
-  --vp-font-family-base: "Space Grotesk", "Inter var experimental", "Inter var",
-    -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell,
-    "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;
-
+ /* Typography */
+  --vp-font-family-base: "Sora";
   /* Code Snippet font */
-  --vp-font-family-mono: "Space Mono", Menlo, Monaco, Consolas, "Courier New",
-    monospace;
-}
+  --vp-font-family-mono: "Space Mono";
+}
diff --git a/docs/changelogs.md b/docs/changelogs.md
@@ -0,0 +1,11 @@
+# Changelogs
+You can check most latest changlogs at [commits](https://github.com/OurCodeBase/gen3-express/commits/main/) or [versions](https://github.com/OurCodeBase/gen3-express/releases) sections in github.
+
+## Changelogs 1.1.0
+tui has been implemented to gen3-express.
+- used signale to implement tui.
+- changes many things in gen3-express file.
+
+## Changelogs 1.0.1
+- nets module has been shifted from `/nets.js` to the utils folder `/utils/nets.js`.
+- docs have also been updated.
diff --git a/docs/documentation.md b/docs/documentation.md
@@ -0,0 +1,85 @@
+# Gen3 Express
+A gen3 tool to generate express app boilerplate.
+
+## Changelogs 1.1.0
+tui has been implemented to gen3-express.
+- used signale to implement tui.
+- changes many things in gen3-express file.
+
+## Acknowledgements
+You need to know atleast basics about these things.
+ - [NodeJS](https://nodejs.org/docs/latest/api/)
+ - [ExpressJS](https://expressjs.com/en/5x/api.html)
+ - [Embedded JS](https://ejs.co/)
+
+## Installation
+You can install and generate an express app using this tool in two approaches. Here I'm generating an app with name `my-app`, you can name to it anything you like.
+
+### 1. node package extecutor
+This method is highly recommended to generate an express app.
+```bash
+npx https://www.github.com/OurCodeBase/gen3-express my-app
+```
+
+### 2. node package manager
+Generation of an express app is not recommended through npm.
+```bash
+npm install -gen3 https://www.github.com/OurCodeBase/gen3-express.git
+```
+```bash
+gen3-express my-app
+```
+
+## Documentation
+To install all dev dependencies goto the folder and hit `npm install` command.
+```bash
+cd my-app
+npm install
+```
+To start a dev server to preview page use `server` word.
+- Keep in mind that
+- The below command does not include EJS live reloading.
+
+```bash
+npm run server
+```
+To start a dev server to live preview EJS page use `sync` word.
+```bash
+npm run sync
+```
+If you want to run all these servers together then you should to use this below command, this command will provide you hot reloadings in every place.
+```bash
+npm run server & npm run sync
+```
+
+## File Cases
+To know about the product or project structure read about files included in this code block.
+
+```bash
+.
+├── app.js # this core file handles express functions and server.
+├── package.json # package file handles dependencies, and details about the product.
+├── public # this folder contains public data like fonts, css and multimedia.
+│   ├── fonts
+│   │   └── sans.woff
+│   └── style.css
+├── sync.js # this file is needed to configure hot reloadings in ejs and static files.
+├── utils
+│   └── nets.js # this file provides functions to display available ip addresses on your network.
+└── views # this folder contains ejs or html files to render contents.
+    └── home.ejs # this file is the landing page of the product.
+```
+
+## Roadmap
+
+- Custom name in `package.json` file ✅
+- Excellent terminal user interface ✅
+- Prompt `package.json` file's details from user. ⏩ 
+- Post this project to npmjs website. ⏩
+- Custom local template feature ⏩
+
+## Authors
+- [@OurCodeBase](https://www.github.com/OurCodeBase)
+
+## Contributing
+Contributions are always welcome!
diff --git a/docs/index.md b/docs/index.md
@@ -1,14 +1,25 @@
 ---
 layout: home 
+
 hero:
     name: Gen3 Express
-    text: A gen3 tool to generate get started express app.
+    text: A gen3 tool to generate express app boilerplate.
+    image:
+        src: /icons/logo.blue.png
+        alt: Gen3 Express
     tagline: A free, unofficial, open-source and stable tool to generate minimal express app.
+    actions:
+    - theme: brand
+      text: Get Started
+      link: /documentation
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/OurCodeBase/gen3-express
 
 features: 
-    - icon: 💫
-      title: Minimal and Useful
-      details: Provides you hot reloading like more features in a very minimal express app.
+    - icon: ⚡
+      title: Minimal Source Code
+      details: The source-code used in this boilerplate is super minimal.
     - icon: 🚀 
       title: JS Hot Reloadings
       details: Provides hot reloadings when you change codes of your JS files.
@@ -19,89 +30,6 @@ features:
       title: Cross Platform
       details: You can use this tool on any platform like Linux, MacOS, Windows (WSL) and also on Android (Termux).
     - icon: 🥙
-      title: NPX (no need to install extra stuff)
+      title: NPX Usable
       details: You don't neet to install a separate tool to generate express apps. You can just simply use npx to fetch files and dependencies temporarily.
----
-
-## Changelogs <Badge type="tip" text="1.0.1" />
-
-> [!CAUTION]
-> nets module has been shifted from `/nets.js` to the utils folder `/utils/nets.js`.
-> docs have also been updated.
-
-## Acknowledgements
-You need to know atleast basics about these things.
- - [NodeJS](https://nodejs.org/docs/latest/api/)
- - [ExpressJS](https://expressjs.com/en/5x/api.html)
- - [Embedded JS](https://ejs.co/)
-
-## Installation
-You can install and generate an express app using this tool in two approaches. Here I'm generating an app with name `my-app`, you can name to it anything you like.
-
-### 1. node package extecutor
-This method is highly recommended to generate an express app.
-```bash
-npx https://www.github.com/OurCodeBase/gen3-express my-app
-```
-
-
-### 2. node package manager
-Generation of an express app is not recommended through npm.
-```bash
-npm install -gen3 https://www.github.com/OurCodeBase/gen3-express.git
-```
-```bash
-gen3-express my-app
-```
-
-## Documentation
-To install all dev dependencies goto the folder and hit `npm install` command.
-```bash
-cd my-app
-npm install
-```
-To start a dev server to preview page use `server` word.
-> [!NOTE]  
-> This does not include EJS and static files live (hot) reloading.
-```bash
-npm run server
-```
-To start a dev server to live preview EJS page use `sync` word.
-```bash
-npm run sync
-```
-If you want to run all these servers together then you should to use this below command, this command will provide you hot reloadings in every place.
-```bash
-npm run server & npm run sync
-```
-
-## File Cases
-To know about the product or project structure read about files included in this code block.
-
-```bash
-.
-├── app.js # this core file handles express functions and server.
-├── package.json # package file handles dependencies, and details about the product.
-├── public # this folder contains public data like fonts, css and multimedia.
-│   ├── fonts
-│   │   └── sans.woff
-│   └── style.css
-├── sync.js # this file is needed to configure hot reloadings in ejs and static files.
-├── utils
-│   └── nets.js # this file provides functions to display available ip addresses on your network.
-└── views # this folder contains ejs or html files to render contents.
-    └── home.ejs # this file is the landing page of the product.
-```
-
-## Milestone
-
-- Custom name in `package.json` file
-- Excellent terminal user interface
-- Prompt `package.json` file's details from user.
-- Post this project to npmjs website.
-
-## Authors
-- [@OurCodeBase](https://www.github.com/OurCodeBase)
-
-## Contributing
-Contributions are always welcome!
+---
diff --git a/docs/public/icons/logo.blue.png b/docs/public/icons/logo.blue.png
diff --git a/docs/public/icons/logo.skyblue.png b/docs/public/icons/logo.skyblue.png
diff --git a/readme.md b/readme.md
@@ -1,8 +1,10 @@
-## Changelogs 1.0.1
+# Gen3 Express
+A gen3 tool to generate express app boilerplate.
 
-> [!TIP]
-> nets module has been shifted from `/nets.js` to the utils folder `/utils/nets.js`.
-> docs have also been updated.
+## Changelogs 1.1.0
+tui has been implemented to gen3-express.
+- used signale to implement tui.
+- changes many things in gen3-express file.
 
 ## Acknowledgements
 You need to know atleast basics about these things.
@@ -19,7 +21,6 @@ This method is highly recommended to generate an express app.
 npx https://www.github.com/OurCodeBase/gen3-express my-app
 ```
 
-
 ### 2. node package manager
 Generation of an express app is not recommended through npm.
 ```bash
@@ -36,8 +37,9 @@ cd my-app
 npm install
 ```
 To start a dev server to preview page use `server` word.
-> [!NOTE]  
-> This does not include EJS and static files live (hot) reloading.
+- Keep in mind that
+- The below command does not include EJS live reloading.
+
 ```bash
 npm run server
 ```
@@ -68,15 +70,16 @@ To know about the product or project structure read about files included in this
     └── home.ejs # this file is the landing page of the product.
 ```
 
-## Milestone
+## Roadmap
 
-- Custom name in `package.json` file
-- Excellent terminal user interface
-- Prompt `package.json` file's details from user.
-- Post this project to npmjs website.
+- Custom name in `package.json` file ✅
+- Excellent terminal user interface ✅
+- Prompt `package.json` file's details from user. ⏩ 
+- Post this project to npmjs website. ⏩
+- Custom local template feature ⏩
 
 ## Authors
 - [@OurCodeBase](https://www.github.com/OurCodeBase)
 
 ## Contributing
-Contributions are always welcome!
+Contributions are always welcome!