arkos 0.0.21 → 0.0.22-alpha.1

package/README.md

@@ -1,4 +1,30 @@
-To use your package, `arkos`, with the provided example, let's break it down into understandable steps.
+![Header Image](src/images/header.webp)
+
+### **What is Arkos**
+
+**Arkos** is a **lightweight backend framework** for **Express.js and Prisma** that simplifies API development by providing automatic route generation, built-in authentication, error handling, and file upload optimization. Designed to be a foundational layer for backend applications, Arkos allows developers to quickly set up a secure and scalable server with minimal configuration.
+
+---
+
+### **Key Features**
+
+- 🚀 **Automatic API Generation** – Instantly create RESTful API routes for Prisma models.
+
+- 🔐 **Built-in Authentication** – Supports JWT-based authentication with effortless setup.
+
+- ⚡ **Express Middlewares** – Pre-configured security, request parsing, and error handling.
+
+- 🛡️ **Built-in Data Validation** – using class-validator and class-transformer, just drop a create-post.dto.ts.
+
+- ⬆️ **File Upload & Optimization** – Efficient image, video, docs, raw-file handling.
+
+- 💠 **Prisma Integration** – Seamless connection with Prisma ORM for database management with relation feilds handling.
+
+- 👨‍💻 **Interceptors Middlewares** – Tailor as you want, intercept, customize, for example using beforeCreateOne, afterSignUp.
+
+- ✉️ **Nodemailer Integration** – Seamless nodemailer integration for sending emails.
+
+With Arkos, developers can **bootstrap their backend in seconds**, focusing on building features rather than repetitive setup tasks.
 
 ### 1. **Install the Package**
 
@@ -16,7 +42,7 @@ pnpm install arkos
 
 ### 2. **Setup Prisma Client**
 
-In the code snippet, you're passing the `prisma` instance to the `arkos.init()` function. Here's how Prisma should be set up:
+Here's how Prisma should be set up to use seamlessly with arkos:
 
 1. **Install Prisma and initialize it:**
    Make sure you have Prisma installed in your project. You can install it using:
@@ -69,7 +95,7 @@ arkos.init(app);
   - **Authentication Setup**: The package will set (read further to learn how to prepare the environment) up authentication routes, middleware, and necessary handlers for managing user sessions and JWT tokens.
   - **Error Handling**: Automatic error handling middleware could be added.
   - **File Upload**: Arkos will configure necessary middleware to handle file uploads, image upload optimization, and route generation.
-  - **Prisma Integration**: The prisma instance must be export as default or prisma under scr/utils/prisma.ts.
+  - **Prisma Integration**: The prisma instance must be export as default or as prisma under scr/utils/prisma.ts.
 
 ### 5. **Additional Configuration (Optional)**
 
@@ -93,7 +119,9 @@ project-root/
 │
 ├── package.json               # Your project dependencies
 └── prisma/
-    └── schema.prisma          # Your Prisma schema file
+    └── schema/
+        └── schema.prisma          # Your Prisma schema file
+        └── post.prisma          # Your Post model file
 ```
 
 ---
@@ -102,7 +130,7 @@ project-root/
 
 Ensure you have a basic Prisma schema like this:
 
-```prisma
+```typescript
 // prisma/schema.prisma
 datasource db {
   provider = "sqlite" // Replace with your database provider (e.g., 'mongodb', 'mysql', 'sqlite', 'postgresql')
@@ -140,8 +168,8 @@ After all there will be routes for
 
 ### Recap
 
-- You need `prisma` properly set up and the `prisma` client instance passed into `arkos.init()`.
-- Once `arkos.init()` is invoked with your `express` app and Prisma client, the package will handle routing, authentication, file uploads, etc., automatically.
+- You need `prisma` properly set up.
+- Once `arkos.init()` is invoked with your `express` app the package will handle routing, authentication, file uploads, etc., automatically.
 - Ensure you have all dependencies installed (`arkos`, `prisma`, `express`, etc.) before running the app.
 
 ---
@@ -150,8 +178,22 @@ After all there will be routes for
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
+---
+
 ## 📫 Contact
 
 For any issues or questions, please open an issue or contact [Uanela Como](mailto:uanelaluiswayne@gmail.com).
 
-## NB: More documentation coming soon
+Feel free to reach out for questions, suggestions, or contributions ❤️.
+
+---
+
+### **Origin of the Name "Arkos"**
+
+The name **"Arkos"** is derived from the Greek word **ἀρχή (Arkhē)**, which means **"beginning"** or **"foundation"**. This interpretation perfectly aligns with the core purpose of the package — to serve as a **foundational layer** for quickly setting up backend systems. Just as **ἀρχή** represents the starting point or origin, Arkos is designed to **initiate** and **structure** backend projects, providing developers with a robust base to build upon.
+
+This makes Arkos an essential tool for **bootstrapping** and organizing backend applications, helping developers focus on features rather than repetitive setup tasks.
+
+---
+
+### NB: More documentation coming soon

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arkos",
-  "version": "0.0.21",
+  "version": "0.0.22-alpha.1",
   "description": "A super customizable TypeScript package for auto-generating API routes with built-in authentication, email service, error handling, file upload routes, image upload optimization, and seamless Prisma integration.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",