create-authenik8-app 2.0.3 → 2.0.4

package/README.md

@@ -1,71 +1,55 @@
-<<<<<<< HEAD
-<<<<<<< HEAD
-
-
-=======
-Good catch — then your README should reflect that. Don’t undersell what you already built.
-
-Let’s fix it properly.
->>>>>>> 5471da4 (Update file README.md)
 
+# Create-authenik8-app
 
----
 
-<<<<<<< HEAD
-=======
-✅ Updated npm README (with RBAC included)
 
-Replace your README with this version:
+<p align="center">
+  <b> A lightweight authentication infrastructure generator powered by an internal Identity Engine.</b>
+  </p>
 
->>>>>>> 5471da4 (Update file README.md)
-# create-authenik8-app
 
-<p align="center">
-  <b>Scaffold secure Express authentication APIs in seconds</b>
-</p>
-<<<<<<< HEAD
+![subtitle](https://readme-typing-svg.demolab.com?font=Fira+Code&size=18&pause=1000&color=00C2FF&width=600&lines=Production-ready+Auth+Generator;JWT+%2B+OAuth+%2B+Prisma+%2B+Redis;Identity+Engine+powered+authentication+system)
 
 <p align="center">
-  JWT • Refresh Tokens • Redis • RBAC • TypeScript • Express
+  <img src="./assets/giffy-ezgif.com-video-to-gif-converter.gif" width="600" />
 </p>
-
 ---
 
-## 📦 Usage
+##  Usage
 
 Create a new project:
 
-```bash
+bash
 npx create-authenik8-app my-app
 
 Then:
 
 cd my-app
-npm install
+redis-server --daemonize yes
 npm run dev
-```
+
 
 ---
 
 ## What you get instantly
 
-A fully working Express authentication starter with:
+• A fully working Express authentication starter with:
 
-JWT authentication (access + refresh tokens)
+• JWT authentication (access + refresh tokens)
 
-Secure refresh token rotation
+•  Secure refresh token rotation
 
-Redis-based token storage
+• Redis-based token storage
 
-Role-Based Access Control (RBAC)
+• Role-Based Access Control (RBAC)
 
-TypeScript setup
+• TypeScript setup
 
-Express server preconfigured
+• Express server preconfigured
 
-Clean scalable folder structure
+• Clean scalable folder structure
 
-.env file generated automatically
+• .env file generated automatically
 
 
 
@@ -99,9 +83,8 @@ Redis (required for refresh tokens)
 
 ---
 
-## Redis Setup
-```
-
+ ## Redis Setup
+ 
 Local
 
 redis-server
@@ -110,228 +93,85 @@ Docker
 
 docker run -p 6379:6379 redis
 
-```
+
 ---
 
 ## Environment Variables
 
 Generated automatically:
-```
+
+
 JWT_SECRET=your-secret
 REFRESH_SECRET=your-refresh-secret
 
 REDIS_HOST=127.0.0.1
 REDIS_PORT=6379
 
-```
+
+
 ---
 
+
+
 ## RBAC Example
-```
-Example of a protected route:
 
+Example of a protected route:
+``
 app.get("/admin", auth.requireAdmin, (req, res) => {
   res.json({ message: "Admin only route" });
 });
+``
 
-```
 ---
-
-📦 Powered by
+## Powered by
 
 authenik8-core
 
-
-
----
-
-## Project Structure
-```
-
-my-app/
-├── src/
-│   | 
-│   ├
-│   └── server.ts
-├── .env
-├── package.json
-└── tsconfig.json
-
-```
----
-
-## Notes
-
-Redis is required for refresh token handling
-
-This CLI generates a starter project, not a full framework
-
-RBAC is included via middleware (e.g. requireAdmin)
-
-
-
----
-
- ## Roadmap
-
-OAuth providers (Google, GitHub)
-
-Advanced RBAC (custom roles/permissions)
-
-Docker templates
-
-Admin dashboard
-
-Production presets
-
-
-
----
-# Create-authenik8-app
-=======
-# create-authenik8-app
->>>>>>> 01efb21 (Update file README.md)
-
-<p align="center">
-  <b>Scaffold secure Express authentication APIs in seconds</b>
-  </p>
-=======
->>>>>>> 5471da4 (Update file README.md)
-
-<p align="center">
-  JWT • Refresh Tokens • Redis • RBAC • TypeScript • Express
-</p>
-
----
-
-##  Usage
-
-Create a new project:
-
-```bash
-npx create-authenik8-app my-app
-
-Then:
-
-cd my-app
-npm install
-npm run dev
-
-
----
-
-## What you get instantly
-
-A fully working Express authentication starter with:
-
-JWT authentication (access + refresh tokens)
-
- Secure refresh token rotation
-
- Redis-based token storage
-
- Role-Based Access Control (RBAC)
-
-TypeScript setup
-
- Express server preconfigured
-
-Clean scalable folder structure
-
- .env file generated automatically
-
-
-
----
-
-🧠 Why Authenik8?
-
-Authentication systems usually require:
-
-manual JWT setup
-
-refresh token handling
-
-Redis/session configuration
-
-access control logic
-
-
-Authenik8 provides all of this out of the box so you can start building your API immediately.
-
-
----
-
-Requirements
-
-Node.js 18+
-
-Redis (required for refresh tokens)
-
-
-
 ---
 
- Redis Setup
- ```
+## Design Goal
+Authenik8 is not an auth library.
+It is an auth system generator.
+It removes setup time and enforces consistent backend security patterns by default.
 
-Local
+Authenik8 treats authentication as an identity resolution problem, not just a login system.
 
-redis-server
+At the core is an Identity Engine that ensures consistent user identity across:
+- credentials (email/password)
+- OAuth providers
+- future authentication strategies
 
-Docker
-
-docker run -p 6379:6379 redis
-```
 ---
 
- Environment Variables
-
-Generated automatically:
-```
-JWT_SECRET=your-secret
-REFRESH_SECRET=your-refresh-secret
-
-REDIS_HOST=127.0.0.1
-REDIS_PORT=6379
-```
+## OAuth
+• Google
+• Github
+OAuth in Authenik8 is not a direct provider integration layer.
 
----
+It is implemented through an internal Identity Engine that sits inside `authenik8-core`.
 
-RBAC Example
+The Identity Engine is responsible for:
+- Resolving OAuth profiles into system identities
+- Handling login vs account linking flows
+- Preventing duplicate identity creation across providers
+- Normalizing provider-specific user data into a unified schema
 
-Example of a protected route:
-```
-app.get("/admin", auth.requireAdmin, (req, res) => {
-  res.json({ message: "Admin only route" });
-});
-```
+This allows OAuth support to remain consistent regardless of provider complexity.
 
 ---
 
-📦 Powered by
+### Production Enhancements
 
-authenik8-core
+- PM2 cluster mode support
+- Auto restart on crashes
+- Memory usage guardrails
+- Basic security middleware (helmet, rate limiting)
 
 
 
 ---
 
-📁 Project Structure
-
-my-app/
-├── src/
-│   ├
-│   ├
-│   └── server.ts
-├── .env
-├── package.json
-└── tsconfig.json
-
-
----
-
-📌 Notes
+## Notes
 
 Redis is required for refresh token handling
 
@@ -343,9 +183,7 @@ RBAC is included via middleware (e.g. requireAdmin)
 
 ---
 
-🧱 Roadmap
-
-OAuth providers (Google, GitHub)
+## Roadmap
 
 Advanced RBAC (custom roles/permissions)
 

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "create-authenik8-app",
-  "version": "2.0.3",
+  "version": "2.0.4",
+
   "description":"Create production-ready backend APIs in seconds. Authenik8 scaffolds Express + Prisma projects with JWT authentication, database setup (PostgreSQL or SQLite), and scalable architecture out of the box.",
   "bin": {
     "create-authenik8-app": "dist/bin/index.js"