@je-es/server 0.1.0 → 0.1.2

package/README.md

@@ -3,41 +3,65 @@
 <br>
 <div align="center">
     <p>
-        <img src="./assets/img/logo.png" alt="logo" style="" height="70" />
+        <img src="./assets/img/logo.png" alt="logo" style="" height="80" />
     </p>
 </div>
 
 <div align="center">
-    <img src="https://img.shields.io/badge/v-0.1.0-black"/>
+    <img src="https://img.shields.io/badge/v-0.1.2-black"/>
     <a href="https://github.com/maysara-elshewehy">
     </a>
-    <a href="https://github.com/je-es/server"> <img src="https://img.shields.io/badge/🔥-@je--es/server-black"/> </a>
-</div>
-
-<div align="center">
-    <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/>
-    <br>
+    <a href="https://github.com/je-es"> <img src="https://img.shields.io/badge/@-je--es-black"/> </a>
 </div>
+<br>
 
 <!-- ╚═════════════════════════════════════════════════════════════════╝ -->
 
 
 
+
 <!-- ╔══════════════════════════════ DOC ══════════════════════════════╗ -->
 
 - ## Quick Start 🔥
 
-    - ### commands
+    > _**The simplest, fastest, most organized and stable way to build servers.**_
 
-        ```bash
-        # install
-        space i @je-es/server
+    > _We prefer to use [`space`](https://github.com//solution-lib/space) with [`@solution-dist/server`](https://github.com/solution-dist/server) for a better experience._
 
-        # manage
-        space test              # run server tests
-        space build             # build server files to ./dist
-        space start             # start server
-        ```
+    - #### Setup
+
+        > install [`space`](https://github.com/solution-lib/space) first.
+
+        - ##### Create
+
+            ```bash
+            space init <name> -t server # This will clone a ready-to-use repo and make some changes to suit your server.
+            cd <name>                   # Go to the project directory
+            space install               # Install the dependencies
+            ```
+
+        - ##### Manage
+
+            ```bash
+            space build                 # To build your server
+            space test                  # To test  your server
+            space start                 # To start your server
+            ```
+
+            ```bash
+            # example
+             > space start
+
+            # output
+             16:16:31 ✓ Server started at http://localhost:3000
+             16:17:25 GET / 200 4ms
+             ...
+            ```
+
+    <br>
+
+
+- ## Examples
 
     - ### Basic Server
 
@@ -92,6 +116,8 @@
         ...
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### With Database
 
         ```typescript
@@ -134,6 +160,8 @@
         // Data persists in ./my_app.db file!
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### With Security
 
         ```typescript
@@ -168,7 +196,7 @@
         await app.start();
         ```
 
-<div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+<br>
 
 - ## API Reference
 
@@ -219,6 +247,8 @@
         await app.start();
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Route Definition
 
         ```typescript
@@ -258,6 +288,8 @@
         };
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Context API
 
         ```typescript
@@ -315,7 +347,7 @@
         }
         ```
 
-<div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+<br>
 
 - ## Security Features
 
@@ -337,6 +369,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### CORS Configuration
 
         ```typescript
@@ -363,6 +397,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### CSRF Protection
 
         ```typescript
@@ -377,6 +413,8 @@
         const isValid = security.validateCsrfToken(token, 'session-id');
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Input Sanitization
 
         ```typescript
@@ -393,7 +431,7 @@
         // Output: ''; DROP TABLE users--
         ```
 
-<div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+<br>
 
 - ## Database Support
 
@@ -412,6 +450,8 @@
         // Access in routes via c.db
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Multiple Databases
 
         ```typescript
@@ -450,6 +490,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Schema Definition
 
         ```typescript
@@ -494,6 +536,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Database Operations
 
         ```typescript
@@ -583,6 +627,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Query Builder
 
         ```typescript
@@ -671,6 +717,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Transactions
 
         ```typescript
@@ -711,6 +759,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Raw SQL
 
         ```typescript
@@ -762,7 +812,7 @@
         });
         ```
 
-<div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+<br>
 
 - ## Advanced Features
 
@@ -792,6 +842,8 @@
         };
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Cookie Management
 
         ```typescript
@@ -838,6 +890,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Dynamic Routing
 
         ```typescript
@@ -873,6 +927,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Health Checks
 
         ```typescript
@@ -899,6 +955,8 @@
         }
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Graceful Shutdown
 
         ```typescript
@@ -924,6 +982,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Dynamic Routes
 
         ```typescript
@@ -951,6 +1011,8 @@
         console.log(routes);
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Request Timeout
 
         ```typescript
@@ -970,6 +1032,8 @@
         });
         ```
 
+    <div align="center"> <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/> <br> </div>
+
     - ### Custom Error Handling
 
         ```typescript
@@ -1010,11 +1074,9 @@
 <!-- ╔══════════════════════════════ END ══════════════════════════════╗ -->
 
 <br>
-<div align="center">
-    <img src="./assets/img/line.png" alt="line" style="display: block; margin-top:20px;margin-bottom:20px;width:500px;"/>
-    <br>
-</div>
-<br>
+
+---
+
 <div align="center">
     <a href="https://github.com/solution-lib/space"><img src="https://img.shields.io/badge/by-Space-black"/></a>
 </div>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@je-es/server",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "Build faster, Sleep better !",
 	"keywords": ["je-es", "server"],
 	"license": "MIT",