หน้าแรก>แหล่งข้อมูลการสร้างเว็บไซต์>ข้อมูลเว็บไซต์
ดาวน์โหลด

แอปพลิเคชันเริ่มต้นสำหรับการสร้าง APIs ด้วย Express.js

มาพร้อมกับ:

  • คุณสมบัติ/โมดูล ES6
  • es7 async/รอ
  • ชั้นวางหนังสือ orm และการอพยพ knex
  • PostgreSQL (ค่าเริ่มต้น) พร้อมการสนับสนุนสำหรับ MySQL และ SQLITE
  • เอกสาร API โดยใช้ swagger-ui-dist และ swagger-jsdoc
  • การสนับสนุนนักเทียบท่าสำหรับการพัฒนาและการผลิต
  • ESLINT สำหรับรหัสผ้าสำลี
  • ขอการตรวจสอบความถูกต้องโดยใช้ Joi
  • การจัดรูปแบบรหัสโดยใช้ Prettier
  • การจัดการการกำหนดค่าโดยใช้ dotenv
  • การเข้าสู่ระบบโดยใช้ Winston
  • การรายงานข้อผิดพลาดโดยใช้ Sentry
  • การทดสอบโดยใช้มอคค่าซูเปอร์เทสต์และชัย
  • VS CODE SUPPOND DEBUGGER ในตัว

ข้อกำหนดเบื้องต้น

  • node.js
  • เส้นด้าย
  • NPM
  • PostgreSQL / mysql / sqlite

การตั้งค่า

โคลนพื้นที่เก็บข้อมูลติดตั้งการพึ่งพาและเริ่มต้นทันที 

 $ git clone --depth=1 [email protected]:mesaugat/express-api-es6-starter.git <application-name>
$ cd <application-name>
$ rm -rf .git
$ yarn   # or npm install

ทำสำเนา .env.example เป็น .env และอัปเดตรายละเอียดแอปพลิเคชันและข้อมูลรับรองฐานข้อมูล ตอนนี้เรียกใช้การอพยพและเมล็ดฐานข้อมูล 

 $ yarn migrate
$ yarn seed

ในที่สุดเริ่มแอปพลิเคชัน 

 $ yarn start:dev (For development)
$ NODE_ENV=production yarn start (For production)

ไปที่ http: // localhost: 8848/api-docs/เพื่อตรวจสอบการติดตั้ง

การสร้างการอพยพและเมล็ดพันธุ์ใหม่

นี่คือคำสั่งเพื่อสร้างการโยกย้ายใหม่และไฟล์เมล็ดที่เกี่ยวข้อง 

 $ yarn make:migration <name>
$ yarn make:seeder <name>

ตัวอย่าง, 

 $ yarn make:migration create_tags_table
$ yarn make:seeder 02_insert_tags

ใช้นักเทียบท่า

ใช้นักเทียบท่า

ใช้ Docker-compose เพื่อนำสแต็กขึ้นมาอย่างรวดเร็วด้วยคอนเทนเนอร์ฐานข้อมูล Postgres ที่กำหนดค่าล่วงหน้า ข้อมูลเป็นชั่วคราวและภาชนะบรรจุจะหายไปเมื่อลบสแต็ก

การกำหนดค่าเฉพาะสำหรับ Docker อยู่ใน .env.docker

  • 0.0.0.0 เป็น $APP_HOST เพื่อเปิดเผยแอพในอินเตอร์เฟสเครือข่าย Docker
  • การตั้งค่า postgres ที่กำหนดค่าล่วงหน้า - สามารถอัปเดตเพื่อชี้ไปที่โฮสต์ Postgres อื่น

นำสแต็กขึ้นมา 

 $ docker-compose up

ไปที่ http: // localhost: 8848/api-docs/เพื่อตรวจสอบแอปพลิเคชันกำลังทำงานจาก Docker

นำสแต็กลงมา 

 $ docker-compose down

นักเทียบท่าหลายขั้นตอนสร้าง

มีเป้าหมายการสร้างหลายอย่างสำหรับขั้นตอนต่าง ๆ ภาพเหล่านี้สามารถใช้ในการปรับใช้หรือเรียกใช้งานในโครงสร้างพื้นฐานคลาวด์ที่ใช้คอนเทนเนอร์ที่แตกต่างกันเช่น Kubernetes, AWS ECs, Fargate, GCP Cloud Run ฯลฯ

  1. สร้างภาพการผลิต 

    $ docker build --target=prod -t express-api-es6-starter:prod .

  2. สร้างภาพเพื่อการพัฒนา 

    $ docker build --target=dev -t express-api-es6-starter:dev .

  3. การสร้างภาพที่เรียกใช้การโยกย้ายและ/หรือย้อนกลับ 

     # Docker image that runs migration and seeds.
 $ docker build --target=migrate -t express-api-es6-starter:migrate .

 # Docker image that rollbacks migrations.
 $ docker build --target=migrate-rollback -t express-api-es6-starter:migrate-rollback .

เมื่อภาพถูกสร้างขึ้น - สิ่งที่คุณต้องทำคือเรียกใช้พวกเขาโดยให้ไฟล์. .env แบบนี้: 

$ docker run -v " /path/to/your/.env:/app/.env " mesaugat/express-api-es6-starter:migrate

ใช้ mysql แทน postgreSQL

ติดตั้งไดรเวอร์ MySQL ก่อน 

 $ yarn add mysql

อัปเดตบรรทัดเหล่านี้ในไฟล์ .env ของคุณ 

 - DB_CLIENT='pg'
+ DB_CLIENT='mysql'

- DB_PORT='5432'
+ DB_PORT='3306'

คุณสามารถลบไดรเวอร์ PG ได้หากคุณต้องการ 

 $ yarn remove pg

นั่นคือคุณพร้อมที่จะม้วน

การทดสอบ

ในการเรียกใช้การทดสอบคุณต้องสร้างฐานข้อมูลการทดสอบแยกต่างหาก อย่าลืมอัปเดตไฟล์ .env ของคุณเพื่อรวมการเชื่อมต่อสำหรับฐานข้อมูลทดสอบ 

 $ NODE_ENV=test yarn migrate
$ yarn test

เรียกใช้การทดสอบด้วยความครอบคลุม 

 $ yarn test:coverage

ทำไมต้อง 8848?

เพราะจุดสูงสุดในโลกคือ 8848 เมตร

การบริจาค

สำหรับการบริจาคและคำขอคุณสมบัติโปรดสร้างปัญหาก่อน

ใบอนุญาต

Express-API-ES6-Starter อยู่ภายใต้ใบอนุญาต MIT

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด