1.1.0 • Published 9 months ago

quickestra v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

Quickestra

Quickestra is a simple easy to use preconfigured ExpressJS application

Installation

To use this module in your project, you need to install it using npm or yarn:

npm install quickestra

Or

yarn add quickestra

Usage

import Application from 'quickestra';

async function main (): Promise<void> {
  const app: Application = new Application();

  await app.configure();
  await app.start();
}

main();

API

The Application class contains the following methods:

getApp

Returns the ExpressJS application instance

const app: Application = new Application();

app.getApp();

getServer

Returns the HTTP server instance

const app: Application = new Application();

app.getServer();

version

Returns the version of the module

const app: Application = new Application();

app.version();

configure

Configures the application

const app: Application = new Application();

await app.configure();

start

Starts the application

const app: Application = new Application();

await app.start();

stop

Stops the application

const app: Application = new Application();

await app.stop();

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details