Unduh node starter kit - Unduh Kode Sumber node starter kit

node starter kit

Data situs web

1.0.0

Unduh

Node.js API Starter Kit

Node.js API Starter Kit adalah templat proyek untuk membangun aplikasi backend node.js yang dioptimalkan untuk infrastruktur tanpa server seperti Google Cloud Functions, AWS Lambda, fungsi Azure, dll. Gunakan sebagai server API untuk aplikasi front-end Anda.

Fitur

Desain Database Pertama; Model data yang sangat diketik secara otomatis (TypeScript)
Otentikasi dan Otorisasi Menggunakan Penyedia OAuth 2.0 (Google, Facebook, GitHub, dll.)
Sesi tanpa kewarganegaraan diimplementasikan dengan token JWT dan cookie sesi (kompatibel dengan SSR)
Contoh API GraphQL, diimplementasikan menggunakan pendekatan pengembangan kode-pertama
Migrasi Skema Database, Biji, dan Perkakas Repl Shell
Email Transaksional Menggunakan Templat Setang dan Pratinjau Email Instan
Log terstruktur dan pelaporan kesalahan ke Google Stackdriver
Perangkat Pengujian Unit yang Dikonfigurasi Pra-Konfigurasi Didukung oleh Jest dan Supertest
Bundling aplikasi dengan rollup sebagai teknik optimasi untuk penyebaran tanpa server
Membangun kembali dan me -restart aplikasi pada perubahan saat berjalan secara lokal
Pra-konfigurasi untuk lingkungan local , dev , test , dan prod
Desain dan pengembangan yang sedang berlangsung didukung oleh perusahaan -perusahaan luar biasa ini:

Proyek ini bootstrap dengan Node.js API Starter Kit. Pastikan untuk bergabung dengan saluran Discord kami untuk mendapatkan bantuan.

Tumpukan teknologi

Node.js v14, manajer paket benang, naskah, babel, rollup, eslint, lebih cantik, bercanda
PostgreSQL, Graphql.js, Knex, Express, Nodemailer, Templat Email, Setang, OAuth2 Sederhana

Struktur Direktori

├── .build Build - Output yang dikompilasi dan dibundel (per fungsi cloud)
├── .vscode - Pengaturan vScode termasuk cuplikan kode, ekstensi yang disarankan dll.
├── api - Fungsi cloud untuk menangani permintaan API menggunakan graphql.js
├── auth - Middleware Otentikasi dan Sesi
├── core - Modul Aplikasi Umum (Email, Logging, dll.)
├── db - Klien Database untuk PostgreSQL Menggunakan Knex
├── emails - Templat Email untuk Email Transaksional Menggunakan Setang
├── env - Variabel Lingkungan untuk local , dev , test , dan prod
├── migrations - Migrasi Skema Database (Cloud SQL, Knex)
├── scripts - skrip penyebaran, shell repl, dll.
├── test - tes unit dan tolok ukur
├── views - Templat HTML Menggunakan Setang
└── ... - Tambahkan lebih banyak fungsi cloud seperti worker , notifications , dll.

Persyaratan

Node.js V14, Manajer Paket Yarn
Instance lokal atau jarak jauh dari PostgreSQL (lihat Postgres.app, Google Cloud SQL)
Editor kode vs dengan ekstensi yang disarankan

Memulai

Klone The Repo- git clone -o seed https://github.com/kriasoft/node-starter-kit.git .
Perbarui variabel lingkungan untuk lingkungan local , dev , test , dan prod ( ./env ).
Instal Dependensi Proyek - yarn install
Basis data bootstrap postgresql - yarn db:create
Akhirnya, luncurkan aplikasi - yarn start , itu akan tersedia di http: // localhost: 8080.

Gunakan variabel lingkungan APP_ENV untuk menjalankan skrip untuk lingkungan yang berbeda, misalnya:

 $ APP_ENV=test yarn db:migrate
$ APP_ENV=test yarn start

PENTING : Pastikan bahwa VScode menggunakan versi Workspace dari TypeScript dan Eslint.

Skrip

yarn start - meluncurkan aplikasi dalam mode pengembangan di http://localhost:8080
yarn build - mengkompilasi dan bundel aplikasi untuk penempatan
yarn lint - Validasi kode menggunakan Eslint
yarn tsc - Validasi Kode Menggunakan Kompiler TypeScript
yarn test - Jalankan Uji Unit dengan Jest, Supertest
yarn repl - Sambungkan ke database menggunakan shell KNEX REPL
yarn psql - Sambungkan ke database menggunakan PostgreSQL CLI
yarn db:create - Buat database baru
yarn db:version - Periksa versi database saat ini
yarn db:migrate - Migrasi Skema Basis Data ke Versi Terbaru
yarn db:rollback - Rollback Migrasi terbaru
yarn db:seed Database Seed dengan Data Sampel / Referensi
yarn db:reset -Menerapkan kembali file migrasi skema DB terbaru
yarn update-types -Menghasilkan model data yang diketik dengan kuat dari skema database

Secara opsional atur APP_ENV ke local (default), dev , test , atau prod sebelum menjalankan skrip ini.

Cara Mengkonfigurasi Aliran Login 0Auth 2.0

Untuk setiap penyedia identitas pihak ke -3 yang perlu diaktifkan untuk aplikasi Anda, Anda harus mendapatkan kredensial aplikasi, sering disebut ID/rahasia klien.

Google

Pergi ke Google Cloud Console
Buat proyek GCP baru
Konfigurasikan Layar Konsentrasi OAuth
Buat klien OAuth 2.0 dengan http://localhost/auth/google/return sebagai url callback
Perbarui GOOGLE_CLIENT_ID , variabel lingkungan GOOGLE_CLIENT_SECRET yang ditemukan di ./env/.env.* untuk setiap lingkungan yang Anda butuhkan.

Dari sana, mengunjungi http://localhost:8080/auth/google (atau, membukanya di jendela popup) akan memulai aliran login melalui Google.

Facebook

Pergi ke situs web pengembang facebook
Buat aplikasi Facebook baru, aktifkan login Facebook untuk aplikasi ini
Tutup dialog QuickStart dan langsung ke pengaturan aplikasi
Tambahkan http://localhost/auth/facebook/return sebagai url panggilan balik untuk aliran login
Salin dan tempel ID aplikasi Facebook yang baru dibuat dan rahasia ke FACEBOOK_APP_ID , FACEBOOK_APP_SECRET variabel yang ditemukan di env/.env.* File untuk setiap lingkungan yang Anda butuhkan.

Dari sana, mengunjungi http://localhost:8080/auth/facebook (atau, membukanya di jendela popup) akan memulai aliran login melalui Facebook.

Cara menggunakan

Script penyebaran ( yarn deploy ) bergantung pada alat Google Cloud CLI ( gcloud ) yang dapat Anda unduh dari sini. Untuk alur kerja CI/CD, Anda mungkin memerlukan gambar Docker seperti ini.

gcloud auth login - Otorisasi alat Google Cloud SDK (CLI) untuk menggunakan akun Google Anda.

Buat proyek GCP baru untuk aplikasi Anda dengan ID seperti example untuk produksi, dan example-test untuk lingkungan tes / QA. Pastikan API Build Cloud dan Cloud Functions API diaktifkan dalam pengaturan proyek GCP Anda di sini.

Buat instance database Cloud SQL di sini di wilayah yang sama di mana aplikasi Anda perlu digunakan. Menggunakan contoh mikro Cloud SQL dengan 0,6 GB RAM harus OK untuk pengujian dan situs web lalu lintas rendah.

Pastikan GOOGLE_CLOUD_PROJECT , GOOGLE_CLOUD_REGION , PGDATABASE , PGUSER dan variabel lingkungan lainnya ditetapkan dengan benar untuk lingkungan penyebaran target (eg /env/.env + /env/.env.prod untuk produksi).

Akhirnya, kompilasi dan gunakan aplikasi dengan menjalankan:

yarn build - Mengkompilasi aplikasi ke dalam folder .build
APP_ENV=<env> yarn db:migrate - migrasi basis data (skema) ke versi terbaru
APP_ENV=<env> yarn deploy - Menyebarkan aplikasi ke Google Cloud Functions (GCF)

Di mana <env> adalah lingkungan target, misalnya APP_ENV=prod yarn deploy .

Cara memperbarui

yarn set version latest - Bump Yarn ke Versi Terbaru
yarn upgrade-interactive -UPDATE NODE.JS MODULES (Dependensi)
yarn pnpify --sdk vscode -Perbarui TypeScript, ESLINT, dan pengaturan yang lebih cantik di VScode

Pendukung

Proyek terkait

GraphQL API Starter Kit-Templat Monorepo, pra-konfigurasi dengan naskah, graphql, react, dan relay.
React Starter Kit-Templat Proyek, pra-konfigurasi dengan webpack dan bereaksi

Bagaimana berkontribusi

Siapa pun dan semua orang dipersilakan untuk berkontribusi. Mulailah dengan memeriksa daftar masalah terbuka yang ditandai bantuan yang diinginkan. Namun, jika Anda memutuskan untuk terlibat, silakan luangkan waktu sejenak untuk meninjau pedoman tersebut.