Description

augejs is a progressive Node.js framework for building applications. It uses modern JavaScript built with TypeScript.

Features

:penguin: Support TypeScript (version 4.0 or higher).
:shell: Minimum core to start with，support plugin by using Extend and Adapter.
:lollipop: Excellent performance with high unit test coverage rate.
:bread: Progressive Development.

Install

This project uses node and npm. Go check them out if you don’t have them locally installed.

npm install @augejs/core

Usage

import { Module, boot } from '@augejs/core';

// we use a @Module decorator to define a module
@Module()
class AppModule {
  async onInit() {
    // the onInit lifecycle method will be called when application boot
    console.log('hello augejs');
  }
}

(async () => {
  // boot the whole application by module.
  await boot(AppModule);
})();

Document

Philosophy

Basic Function

Standard Modules

Koa Modules

Other Modules

…

Examples

see the Examples. :open_book:

Art of Readme - 💌 Learn the art of writing quality READMEs.
open-source-template - A README template to encourage open-source contributions.

Maintainers

Alex Zhang.

Contributing

Feel free to dive in! Open an issue or submit PRs.

augejs follows the Contributor Covenant Code of Conduct.

augejs.github.io

augejs

Table of Contents