Create Node App CLI

Create Node App, hızlı bir şekilde Node.js proje yapısı oluşturmanı sağlayan bir komut satırı aracıdır. Bu araç, Express tabanlı projeler için temel dosya ve klasör yapısını hazırlar, böylece her seferinde tekrar tekrar dosya oluşturmak zorunda kalmazsın.

Kurulum

CLI aracını global olarak kullanabilmek için aşağıdaki adımları izleyin.

1. Npm Üzerinden Kurulum

Paketinizi npm üzerinden global olarak kurun:

npm install -g burak-node

2. Yerel Kurulum (npm link ile)

Projeyi yerel olarak test etmek isterseniz:

1. Proje dizininde npm link çalıştırın:

   npm link

2. İstediğiniz klasörde CLI komutunu çalıştırarak proje oluşturun:

   create-node-app my-new-project

Kullanım

Proje oluşturmak için, create-node-app komutunu çalıştırın ve proje ismini belirtin:

create-node-app my-new-project

Gereksinimleri indirmek için:

npm install

Bu komut, aşağıdaki dosya ve klasör yapısını oluşturacaktır:

my-new-project/
├── .babelrc
├── .env
├── .gitignore
├── .sequelizerc
├── api/
│   ├── app.js
│   ├── config/
│   │   └── swaggerOptions.js
│   ├── controllers/
│   │   └── userController.js
│   ├── helpers/
│   │   └── token.js
│   ├── middlewares/
│   │   ├── error.js
│   │   └── notFound.js
│   ├── routes/
│   │   ├── index.js
│   │   └── users.js
│   └── services/
│       └── userService.js
└── package.json

Örnek Proje Yapısı

• api/controllers: İş mantığını yöneten controller dosyaları.
• api/services: Veri erişimi ve iş mantığını içeren service dosyaları.
• api/routes: API yollarını belirleyen route dosyaları.
• api/middlewares: Hata yönetimi ve middleware'ler.
• api/config: Swagger için config dosyası.

Özellikler

• Express ile temel bir API yapısı oluşturur.
• JWT Authentication için hazır helper.
• Express-Swagger-Generator ile Swagger dokümantasyonu ekler.
• Babel yapılandırması ile modern JS kullanımı.

Geliştirme

Projeyi geliştirirken aşağıdaki komutu çalıştırarak geliştirme modunda kullanabilirsiniz:

npm run dev

Bu komut, projenizi nodemon ve babel ile başlatır ve her değişiklikte sunucuyu otomatik olarak yeniden başlatır.

Lisans

MIT Lisansı © Burak Kepüç