CityRay / outdoorka_backend

OUTDOORKA 揪好咖 Backend API Project

API

https://test

參考 example.env 建立 config.env

PORT=
DATABASE_URL=
DATABASE_PASSWORD=
JWT_TOKEN=
JWT_SECRET=

Setup

Node 版本為 v20.12.0

npm install

Develop

npm run dev

ESlint Start

npm run lint

Swagger

SwaggerUI ： http://localhost:3006/api-docs

npm run swagger

使用的工具套件

• Node.js
• Express
• Typescript
• MongoDB
• Mongoose
• Redis
• ESLint
• prettier
• Husky
• SwaggerUI

File Structure

┣ 📂public
┃ ┗ 📂images
┣ 📂src
┃ ┣ 📂connections
┃ ┣ 📂controllers
┃ ┣ 📂middleware
┃ ┣ 📂models
┃ ┣ 📂routes
┃ ┣ 📂services
┃ ┣ 📂types
┃ ┃ ┣ 📂dto
┃ ┃ ┣ 📂enum
┃ ┣ 📂utils