augejs

〰️〰️〰️💠

augejs is a progressive Node.js framework for building applications.

🌟 Star us on GitHub — it helps! 👏

https://github.com/augejs/augejs.github.io

Table of Contents

• Description
• Features
• Install
• Usage
• Document
• Examples
• Related Efforts
• Maintainers
• Contributing
• License

Description

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

Features

• 🐧 Support TypeScript (version 4.0 or higher).
• 🐚 Minimum core to start with，support plugin by using Extend and Adapter.
• 🍭 Excellent performance with high unit test coverage rate.
• 🍞 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

• IOC
• Application
• Boot
• Progressive Development

Basic Function

• Module
• Provider
• ScanHook
• LifecycleHook
• Cluster
• Config
• Logger
• Name
• Tag

Standard Modules

• AMQP
• Axios
• FileConfig
• I18N
• Koa
• Log4js
• Mail
• Redis
• Schedule
• TypeOrm
• Views

Koa Modules

• Koa-bodyParser
• Koa-compress
• Koa-error-handle
• Koa-multer
• Koa-security
• Koa-session
• Koa-static

Other Modules

...

Examples

see the Examples. 📖

Related Efforts

• 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.

License

MIT © augejs