create-kontas v2.0.111

🚀 KONTAS - Koding Fantasi

KONTAS Stack adalah platform pengembangan modern dan super canggih yang dirancang khusus untuk mempercepat proses pengembangan API menggunakan MongoDB dan GraphQL/REST. Dengan fitur-fitur yang inovatif, KONTAS membantu kamu menciptakan API kompleks hanya dalam hitungan detik! 🚀

🌟 Fitur Unggulan KONTAS

1️⃣ Kemudahan Setup

• Proses instalasi super cepat menggunakan satu perintah sederhana.
• Otomatis menghasilkan struktur proyek yang rapi dan terorganisasi.

2️⃣ CLI Canggih

• Membuat model, schema, dan seeder hanya dengan satu perintah.
• Mendukung framework seperti MongoDB + GraphQL/REST dan segera hadir untuk Next.js serta TypeScript.

3️⃣ GraphQL/REST Otomatis

• CRUD otomatis untuk model yang dibuat.
• Dukungan penuh untuk GraphQL Playground dan Postman.

4️⃣ Seeding yang Mudah

• Proses reset, tambah, atau hapus data database dengan perintah sederhana.

5️⃣ Modular dan Scalable

• Struktur proyek yang mudah diperluas untuk kebutuhan aplikasi besar.
• Dukungan middleware untuk pengelolaan tugas umum.

6️⃣ Dukungan Komunitas

• Aktif di platform seperti Discord dan GitHub untuk membantu semua developer.

📚 Panduan Lengkap Penggunaan KONTAS

Di bawah ini, kamu akan menemukan tutorial langkah demi langkah untuk memulai, mengatur, dan memaksimalkan potensi KONTAS. Kami juga menyertakan tips praktis, contoh nyata, dan troubleshooting agar pengalaman pengembanganmu semakin menyenangkan. 🚀

1️⃣ Instalasi & Setup Proyek dengan KONTAS

Langkah pertama untuk memulai perjalanan bersama KONTAS adalah dengan membuat proyek baru. Dengan tiga cara berikut, kamu bisa langsung memulai tanpa kerumitan:

npx create-kontas my-app    # Membuat folder baru dengan nama "my-app"
npx create-kontas .         # Menggunakan folder saat ini untuk proyek baru
npx create-kontas           # KONTAS akan meminta nama proyek

Setelah menjalankan salah satu perintah di atas, kamu akan diminta untuk:

1. Memilih framework:

   • MongoDB + Apollo GraphQL (Siap digunakan!) 🚀
   • MongoDB + Express REST (Siap digunakan!) 🚀
   • MongoDB + Express + TypeScript (Siap digunakan!) 🚀
   • MongoDB + Next.js (Akan hadir Januari 2025) ⏳

2. Menentukan MongoDB URI: (Default: mongodb://localhost:27017)

3. Memberikan nama database: (Default: nama_project)

Langkah ini hanya membutuhkan beberapa detik, dan proyekmu akan langsung siap untuk dikembangkan. 🎉

2️⃣ Menguasai CLI: Perintah Dasar KONTAS

KONTAS menyediakan CLI (Command Line Interface) yang powerful untuk mempermudah pekerjaanmu. Berikut format umum untuk menjalankan perintah CLI:

# Framework
MongoDB + Apollo GraphQL        === mongajs
MongoDB + Express REST          === mongoejs
MongoDB + Express + TypeScript  === mongoets

# Format dasar
npx kontas-cli <framework> <nama_model> <field_name>:<field_type>

# Contoh untuk framework MongoDB + Apollo GraphQL (mongajs):
# ⚠️ WARNING: Jika sudah menggunakan create-kontas, maka tidak perlu lagi init
# ⚠️ PERINGATAN: Perintah init hanya untuk proyek yang belum menggunakan create-kontas
npx kontas-cli mongajs init

# Generate model
npx kontas-cli mongajs generate User name:string email:string

# Alias lebih pendek
npx kontas-cli mongajs g User name:string email:string

# ⚠️ INGAT! JANGAN SAMPAI SALAH NAMA FRAMEWORK! ⚠️
# MongoDB + Apollo GraphQL, maka nama framework adalah mongajs
npx kontas-cli mongajs g User name:string email:string

# Jika MongoDB + Express REST, maka nama framework adalah mongoejs
npx kontas-cli mongoejs g User name:string email:string

# Jika MongoDB + Express + TypeScript, maka nama framework adalah mongoets
npx kontas-cli mongoets g User name:string email:string

# dll

Keunggulan KONTAS CLI:

• Cepat: Semua otomatis, tidak perlu konfigurasi manual.
• Fleksibel: Mendukung berbagai framework dan skenario.
• Mudah: Cukup satu perintah untuk membuat model, schema/controller, dan seeder.

3️⃣ Perintah Penting dalam Proyek

Berikut adalah beberapa perintah yang wajib kamu kuasai:

npm run dev          # Menjalankan server dengan hot reload untuk pengembangan
npm run start        # Menjalankan server dalam mode produksi
npm run seed         # Reset database dan seed ulang data
npm run seed:up      # Menambahkan data baru tanpa mereset database
npm run seed:down    # Menghapus semua data dari database

// untuk mongoets wajib menggunakan Bun

bun dev      # Menjalankan server dengan hot reload untuk pengembangan
bun seed     # Reset database dan seed ulang data
bun start    # Menjalankan server dalam mode produksi

untuk menggunakan Bun, maka install dulu Bun

npm install -g bun

untuk package

bun install
bun add bcryptjs jsonwebtoken
bun remove bcryptjs jsonwebtoken

# dll

4️⃣ Membuat Model & Schema

Fitur utama KONTAS adalah kemampuan untuk membuat model dan schema dengan satu perintah sederhana. Contohnya:

# Format lengkap
npx kontas-cli mongajs generate User name:string age:number

# Format pendek
npx kontas-cli mongajs g User name:string age:number

# Jika MongoDB + Express REST, maka nama framework adalah mongoejs
npx kontas-cli mongoejs g User name:string age:number

# Jika MongoDB + Express + TypeScript, maka nama framework adalah mongoets
npx kontas-cli mongoets g User name:string age:number

Jenis tipe data yang didukung:

Untuk MongoDB + Apollo GraphQL (mongajs) & MongoDB + Express REST (mongoejs):

• string -> String
• number -> Float
• integer -> Int
• boolean -> Boolean
• date -> Date
• id -> ID
• float -> Float
• json -> JSON
• [string] -> String
• [number] -> Float
• [integer] -> Int
• [boolean] -> Boolean
• [date] -> Date
• [id] -> ID
• [float] -> Float
• [json] -> JSON

Untuk MongoDB + Express + TypeScript (mongoets):

• string -> String (z.string())
• number -> Number (z.number())
• boolean -> Boolean (z.boolean())
• date -> Date (z.date())
• array -> Array of strings (z.array(z.string()))
• object -> Object with string values (z.record(z.string()))
• email -> Email string (z.string().email())
• url -> URL string (z.string().url())
• uuid -> UUID string (z.string().uuid())
• enum -> Enum of values (z.enum(values))
• json -> JSON object (z.record(z.unknown()))

5️⃣ Seeding Data ke Database

Proses seeding sangat mudah dengan KONTAS. Ikuti langkah berikut:

1. Edit file JSON di folder data/[model].json. Contoh:

[
    {
        "_id": "000000000000000000000001",
        "name": "Hens MSN",
        "email": "hendymms@engineer.com",
        "age": 25
    }
]

6️⃣ Menggunakan GraphQL Playground

GraphQL Playground memungkinkanmu untuk menguji API dengan antarmuka yang interaktif. Ikuti langkah berikut:

1. Jalankan server:

npm run dev

2. Buka http://localhost:4000 di browser.

3. Contoh query GraphQL:

# Mendapatkan semua user
query {
    users {
        _id
        name
        email
    }
}

# Membuat user baru
mutation {
    createUser(input: {
        name: "Hens MSN"
        email: "hendymms@engineer.com"
        age: 25
    }) {
        _id
        name
    }
}

7️⃣ Menggunakan Postman untuk testing API pada MongoDB + Express REST

Postman adalah alat yang sangat membantu untuk testing API. Berikut adalah contoh penggunaan Postman untuk testing API pada MongoDB + Express REST:

1. Buka Postman
2. Buat request baru
3. Pilih method HTTP yang ingin digunakan (GET, POST, PUT, DELETE)
4. Masukkan URL API yang ingin digunakan
5. Masukkan header Authorization dengan value Basic Auth
6. Masukkan body request dengan format JSON
7. Klik tombol Send

Contoh request untuk mendapatkan semua user:

GET http://localhost:3000/api/users

Contoh request untuk membuat user baru:

POST http://localhost:3000/api/users

{
    "name": "Hens MSN",
    "email": "hendymms@engineer.com",
    "age": 25
}

8️⃣ Tips dan Trik untuk Pengembangan

Berikut adalah beberapa tips untuk memaksimalkan penggunaan KONTAS:

1. Alur Kerja yang Ideal:

# 1. Membuat proyek baru
npx create-kontas my-app

# 2. Membuat model
npx kontas-cli mongajs generate User name:string
npx kontas-cli mongajs generate Product name:string

# Atau kalau misalnya MongoDB + Express REST
npx kontas-cli mongoejs generate User name:string email:string age:number
npx kontas-cli mongoejs generate Product name:string price:number

# Atau kalau misalnya MongoDB + Express + TypeScript
npx kontas-cli mongoets generate User name:string email:string age:number
npx kontas-cli mongoets generate Product name:string price:number

# 3. Edit data untuk seeder
# Tambahkan data di data/user.json & data/product.json

# 4. Seed database
npm run seed

# 5. Mulai pengembangan
npm run dev

# JIKA MENGUNAKAN BUN
bun seed
bun dev

2. Praktik Terbaik:

• Buat model yang modular dan terfokus.
• Gunakan middleware untuk tugas umum seperti validasi.
• Selalu tulis dokumentasi kode yang jelas.
• Untuk proyek besar, pertimbangkan menggunakan TypeScript.

"Think out of the box" - Hens MSN

👥 Tim Kami

KONTAS Stack diciptakan dengan penuh semangat oleh:

• Hens MSN - Lead Architect
• Karisha Oka - Backend Developer
• Adella Java - Database Architect
• Rafles S - QA Engineer
• Seno W - DevOps Engineer

Kami adalah tim yang berkomitmen untuk memberikan solusi terbaik bagi para developer di seluruh dunia.

🤝 Kontribusi

Kamu ingin ikut serta dalam pengembangan KONTAS? Kami selalu membuka kesempatan untuk kontribusi! Kunjungi GitHub repo kami untuk informasi lebih lanjut.

Panduan Kontribusi

1. Fork repository kami di GitHub.
2. Buat branch baru untuk fitur atau perbaikan yang ingin kamu tambahkan.
3. Lakukan pull request dan tuliskan deskripsi rinci.
4. Diskusikan dengan tim untuk penggabungan kode.

📝 License

KONTAS Stack dirilis di bawah lisensi MIT dan dikembangkan dengan cinta ❤️ oleh tim KONTAS Stack. Untuk informasi lebih lanjut, kunjungi GitHub kami.

📚 Q&A

1. Apakah KONTAS Stack bisa digunakan untuk proyek besar?

Sebenarnya, KONTAS Stack sudah bisa digunakan untuk proyek besar dan kompleks, tapi kami masih dalam tahap pengembangan dan testing. Kami akan segera merilis versi stabil untuk proyek besar dan kompleks.

2. Apakah KONTAS Stack bisa digunakan untuk proyek kecil?

KONTAS Stack dirancang untuk proyek kecil dan sederhana. Dengan fitur-fitur yang inovatif, KONTAS membantu kamu menciptakan API kompleks hanya dalam hitungan detik! HANYA LEWAT KONTAS CLI 🚀

3. Apakah KONTAS Stack berbayar?

KONTAS Stack adalah platform gratis dan open source. Kami tidak akan mengenakan biaya apapun untuk penggunaan KONTAS Stack.

4. Seberapa cepat performa KONTAS Stack?

KONTAS Stack sangat cepat dan canggih, anda hanya perlu menyiapkan data.json yg diperlukan, dan kontas akan membuatkan backend anda dengan cepat dan canggih dengan code yang simple dan mudah dipahami dan juga efisien.

KONTAS: Solusi pengembangan API tercepat dan paling canggih untuk era modern. Mulai proyekmu sekarang dan rasakan bedanya!