lapeh

Lapeh Framework - Modern Node.js & TypeScript API Framework

Lapeh adalah framework Node.js berbasis Express dan TypeScript yang dirancang untuk kecepatan dan skalabilitas. Menggabungkan fleksibilitas Express dengan struktur solid ala Laravel dan NestJS, Lapeh memberikan pengalaman development REST API yang cepat, terstandarisasi, dan siap produksi.

Cocok untuk developer yang mencari Express boilerplate dengan fitur lengkap: Authentication, dan Zero-Config Redis.

🚀 Fitur Utama

• Production Ready: Struktur folder modular (MVC) yang mudah dikembangkan.
• TypeScript First: Full type-safety untuk mengurangi runtime error.
• Database Agnostic: Bebas pilih database dan ORM pilihan Anda.
• Standardized Structure: Controller, Service, dan Route yang terpisah rapi.
• Auto CLI Generator: Buat modul dan controller dengan satu perintah.
• Smart Caching: Otomatis menggunakan Redis jika tersedia, fallback ke in-memory jika tidak.
• Secure by Default: Dilengkapi Helmet, Rate Limiting, CORS, dan JWT Auth.
• Robust Validation: Validasi request otomatis menggunakan Zod.
• High Performance: Mendukung Fast-Serialization (Fastify-style) untuk response JSON super cepat.
• Scalable: Siap untuk deployment Cluster/Load Balancer dengan Redis Store.

🔮 Roadmap (Rencana Masa Depan)

Lapeh Framework akan terus berkembang menjadi solusi Enterprise yang lengkap. Kami memiliki rencana besar untuk fitur-fitur seperti Job Queues, Storage Abstraction (S3), Mailer, dan OpenAPI Generator.

Lihat detail rencana pengembangan di ROADMAP.md.

🤝 Berkontribusi (Open Source)

Lapeh adalah proyek Open Source dan kami sangat terbuka untuk kontribusi dari komunitas! Baik itu perbaikan bug, penambahan fitur, atau perbaikan dokumentasi.

Ingin ikut berkontribusi? Silakan baca Panduan Kontribusi (CONTRIBUTING.md) untuk memulai.

📚 Dokumentasi Lengkap

Kami menyusun "Learning Path" agar Anda bisa memahami framework ini dari nol hingga mahir.

🐣 Level 1: Pemula (Wajib Baca)

• Pengenalan Framework: Mengapa framework ini ada? Apa bedanya dengan yang lain?
• Getting Started: Instalasi dan setup awal.
• Bedah Struktur Folder: Pahami fungsi setiap file dan direktori.
• Referensi Package: Penjelasan kegunaan setiap library yang terinstall.
• Cheatsheet (Contekan): Daftar perintah & kode cepat.

🔨 Level 2: Membangun Aplikasi

• CLI Tools: Percepat kerja dengan generator kode (make:module, dll).
• Tutorial Studi Kasus: Bikin API "Perpustakaan" dari nol sampai jadi.
• Fitur & Konsep Inti: Validasi, Auth, RBAC, dan Serializer.

🚀 Level 3: Mahir & Production

• Performance Guide: Tips optimasi high-scale app.
• Security Best Practices: Panduan mengamankan aplikasi.
• Deployment Guide: Cara deploy ke VPS, Docker, atau Cloud.
• FAQ & Troubleshooting: Solusi masalah umum.
• Changelog: Riwayat versi.

📦 Instalasi & Penggunaan

Anda dapat menginstall framework ini menggunakan versi terbaru:

npx lapeh@latest nama-project-anda

Perintah di atas akan membuat proyek bersih (clean slate):

• Struktur folder dibuat.
• Dependensi diinstall.
• Folder bin dan lib framework tersembunyi di node_modules agar root proyek Anda tetap rapi.

Apa yang terjadi otomatis?

• Struktur project dibuat (Core framework tersembunyi sebagai dependency).
• Dependencies diinstall.
• JWT Secret di-generate otomatis.

Masuk ke folder project dan jalankan:

cd nama-project-anda
npm run dev

Catatan: Perintah npm run dev sekarang menggunakan CLI internal framework (lapeh dev), memberikan pengalaman development yang lebih stabil dan terstandarisasi. Core framework (bin dan lib) tidak lagi memenuhi root folder Anda, tetapi tersimpan aman sebagai dependency.

Server akan berjalan di http://localhost:8000.

🛡️ Keamanan & Pembaruan

Framework ini didesain dengan memprioritaskan keamanan:

• Zero-Vulnerability Policy: Kami secara rutin melakukan audit dependensi (npm audit) untuk memastikan tidak ada celah keamanan.
• Framework-as-Dependency: Dengan menyembunyikan core logic di node_modules, pembaruan framework menjadi lebih mudah (cukup update versi lapeh di package.json) tanpa merusak kode aplikasi Anda.

🔄 Upgrade Project

Jika Anda memiliki project lama yang dibuat dengan versi Lapeh sebelumnya dan ingin memperbarui struktur, scripts, dan konfigurasi ke standar terbaru (termasuk keamanan Redis baru), Anda tidak perlu membuat project ulang.

Cukup jalankan perintah ini di dalam folder project Anda:

npx lapeh@latest upgrade

Perintah ini akan secara otomatis:

• Mengupdate scripts/ (termasuk generator controller baru).
• Mengupdate docker-compose.yml (keamanan Redis).
• Mengupdate dependencies di package.json.
• Menambahkan konfigurasi .vscode dan tsconfig terbaru.

Catatan: File .env Anda tidak akan ditimpa, namun kami akan mengupdate .env.example sebagai referensi konfigurasi terbaru.

🧠 Zero-Config Redis

Lapeh otomatis mendeteksi ketersediaan Redis.

• Auto-Discovery: Mencoba terhubung ke Redis URL di .env (REDIS_URL).
• Smart Fallback: Jika Redis tidak tersedia atau koneksi gagal, otomatis beralih ke In-Memory Mock.
  • Tidak perlu install Redis di local development.
  • Fitur rate-limiting dan caching tetap berjalan (namun data hilang saat restart).
• Production Safety: Memberikan peringatan log jika berjalan di Production menggunakan Mock.

Force Mock Mode: Anda bisa memaksa menggunakan mock (misal untuk testing) dengan menambahkan env variable:

NO_REDIS=true

Optional: Menggunakan Real Redis dengan Docker

Jika Anda ingin menggunakan Redis yang sebenarnya di local environment, kami telah menyertakan konfigurasi docker-compose.yml yang aman (menggunakan ACL).

• Jalankan Redis container:

  docker-compose up -d
  

• Uncomment konfigurasi Redis di file .env Anda:

  REDIS_URL="redis://lapeh:12341234@localhost:6379"
  

  Credential Default:

  • User: lapeh
  • Password: 12341234

🛠 Development Tools

API Lapeh menyediakan tools untuk mempercepat development, mirip dengan artisan di Laravel.

1. Membuat Module (Resource)

Membuat Controller, Service, dan Route sekaligus.

npm run make:module NamaResource
# Contoh: npm run make:module Product

Command ini akan membuat:

• src/controllers/product.controller.ts
• src/services/product.service.ts
• src/routes/product.route.ts (dan otomatis didaftarkan di src/routes/index.ts jika memungkinkan)

2. Membuat Controller

Membuat file Controller baru. Gunakan flag -r untuk membuat controller lengkap dengan method CRUD (index, show, store, update, destroy).

npm run make:controller NamaController
# Contoh Basic: npm run make:controller PaymentController

# Contoh Resource (CRUD Lengkap):
npm run make:controller PaymentController -r

3. Database (No-ORM)

Since v3.0.0, Lapeh Framework does not include a default ORM (like Prisma). We believe in giving you full control over your database stack.

You can freely choose to use:

• Prisma (Manual installation)
• TypeORM
• Drizzle ORM
• Mongoose
• Raw SQL (pg, mysql2)

The framework provides a Validator class for request validation and a Serializer for response formatting, but data persistence is up to you.

4. Generate JWT Secret

Jika Anda perlu me-refresh secret key JWT:

npm run generate:jwt

5. Maintenance (Clear Config)

Membersihkan cache framework, NPM, build artifacts, dan temporary files (sangat berguna jika mengalami isu cache aneh atau ingin reset environment development).

npm run config:clear

• Menghapus node_modules/.cache
• Menghapus dist/
• Menghapus dump.rdb (Redis Persistence)
• Membersihkan npm cache

📂 Struktur Folder

src/
├── controllers/     # Logika Request & Response
├── services/        # Business Logic
├── routes/          # Definisi Route API
├── middleware/      # Auth, Validation, Error Handling
├── schema/          # Zod Validation Schemas
├── utils/           # Helper Functions
└── index.ts         # App Entry Point

📝 Lisensi

MIT

🚀 Deployment Guide

1) Build

• Build: npm run build
• Start (dev): npm run start
• Start (prod): npm run start:prod

2) Production Environment

• Pastikan .env berisi kredensial production:
  • JWT_SECRET (gunakan npm run generate:jwt untuk mengganti)
  • Database credentials (sesuai pilihan ORM/DB Anda)

3) Menjalankan dengan PM2

• Install PM2:

npm i -g pm2

• Jalankan aplikasi:

pm2 start dist/src/index.js --name lapeh-api --time

• Simpan proses agar auto-start saat reboot:

pm2 save
pm2 startup

• Monitoring:

pm2 status
pm2 logs lapeh-api
pm2 restart lapeh-api

4) Nginx Reverse Proxy (Recommended)

• Buat server block /etc/nginx/sites-available/lapeh:

server {
  listen 80;
  server_name example.com;

  location / {
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_pass http://127.0.0.1:8000;
  }
}

• Aktifkan:

sudo ln -s /etc/nginx/sites-available/lapeh /etc/nginx/sites-enabled/lapeh
sudo nginx -t
sudo systemctl reload nginx

• SSL (opsional, Certbot):

sudo apt install certbot python3-certbot-nginx -y
sudo certbot --nginx -d example.com

5) Apache 2 Reverse Proxy (Alternatif)

• Enable modul proxy:

sudo a2enmod proxy proxy_http headers
sudo systemctl reload apache2

• Buat vhost /etc/apache2/sites-available/lapeh.conf:

<VirtualHost *:80>
  ServerName example.com
  ProxyPreserveHost On
  ProxyRequests Off
  <Proxy *>
    Require all granted
  </Proxy>
  ProxyPass / http://127.0.0.1:8000/
  ProxyPassReverse / http://127.0.0.1:8000/
  ErrorLog ${APACHE_LOG_DIR}/lapeh-error.log
  CustomLog ${APACHE_LOG_DIR}/lapeh-access.log combined
</VirtualHost>

• Aktifkan:

sudo a2ensite lapeh.conf
sudo apachectl configtest
sudo systemctl reload apache2

6) Checklist Produksi

• pm2 status menunjukkan proses hidup
• Proxy (Nginx/Apache) menuju port aplikasi (default 8000)
• .env aman dan tidak di-commit ke repository