Skip to content

Use Koa to quickly deploy static projects, support instance extensions such as adding routes or middleware, etc.

License

Notifications You must be signed in to change notification settings

sishen654/quickly-deploy

Repository files navigation

quickly-deploy

English | 简体中文

✨ Introduce

This is a package that can help you quickly deploy your static web, use the Koa framework, you can also add more extension in the app.

📦 Install

npm i quickly-deploy
yarn add quickly-deploy
pnpm add quickly-deploy

🌍 TS support

  • filePath:static folder path, can add multiple
  • envPath:env file path
  • pushArr: add pre-middleware
  • unshiftArr: add post middleware
import * as http from 'http';
import Koa from 'koa';

declare function startServer(filePath?: string[], envPath?: string, pushArr?: Koa.Middleware[], unshiftArr?: Koa.Middleware[]): {
    start(msg?: string, preload?: ((app: Koa) => void) | undefined, started?: () => void): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
};

export { startServer as default };

🔨 Usage

deploy web

import startServer from "quickly-deploy"
import path from "path"
import { fileURLToPath } from "url"

const __dirname = path.dirname(fileURLToPath(import.meta.url))
const envPath = path.resolve(__dirname, "./server.env")		// env path

let app = startServer([path.resolve(__dirname, "../www")], envPath)
app.start()		// start server
# server.env
PORT=3997

About

Use Koa to quickly deploy static projects, support instance extensions such as adding routes or middleware, etc.

Resources

License

Stars

Watchers

Forks

Packages

No packages published