Indexed by TopGit from live GitHub metadata: typestack/microframework has 73 stars, written primarily in TypeScript. [deprecated] Microframework is a simple tool that allows you to execute your modules in proper order, helping you to organize bootstrap code in your application.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Microframework is deprecated, please use routing-controllers instead!
Microframework is a simple tool that allows you to execute and configure your modules (called loaders) in a proper order,
helping you to organize bootstrap code in your application.
Usage
First, install microframework:
npm i microframework
Second, create a simple "loader" named expressLoader.
Loader is a place where you can configure all your modules during microframework bootstrap.
All loaders are executed one by one in a sequential order.
import { MicroframeworkSettings } from 'microframework';
export function expressLoader(settings: MicroframeworkSettings) {
// create express app
const app = express();
// register all routes, Routes are just routes that should be stored outside of this module
const routes: any = Routes;
Object.keys(routes).forEach(routePath => app.get(routePath, routes[routePath]));
// run application to listen on given port
app.listen(3000);
// your loader also can return a promise and microframework will wait for it in a proper order
}
Create app.ts and bootstrap a microframework and your express loader:
import { bootstrapMicroframework } from 'microframework';
import { expressLoader } from './expressLoader';
bootstrapMicroframework([expressLoader])
.then(() => console.log('Application is up and running.'))
.catch(error => console.log('Application is crashed: ' + error));
That's all. You can do same for other loaders.
Take a look on sample to understand better how concept of loaders and their bootstrapping in microframework.
Settings
You can specify additional options to microframework.
logo - Logo needs to be used before application launches. To use logo ansi-art node module should be installed.
showBootstrapTime - If set to true then framework shows how much time was spend to bootstrap microframework.
bootstrapTimeout - Number of milliseconds to wait before framework will bootstrap.
Example of using settings:
import { bootstrapMicroframework } from 'microframework';
import { expressLoader } from './expressLoader';
bootstrapMicroframework({
config: {
logo: 'MyApp',
showBootstrapTime: true,
bootstrapTimeout: 10,
},
loaders: [
expressLoader,
// ...
],
})
.then(() => console.log('Application is up and running.'))
.catch(error => console.log('Application is crashed: ' + error));
Sharing data across loaders
Sometimes few loaders need to communicate between each other and use shared data.
For such purpose you can store the data in settings object passed to each loader
and use stored data across all other loaders. For example:
import { MicroframeworkSettings } from 'microframework';
export function expressLoader(settings: MicroframeworkSettings) {
// create express app
const app = express();
// register all routes, Routes are just routes that should be stored outside of this loader
const routes: any = Routes;
Object.keys(routes).forEach(routePath => app.get(routePath, routes[routePath]));
// run application to listen on given port
app.listen(3000);
settings.setData('express_app', app);
}
And another loaders can use data this way:
import { MicroframeworkSettings } from 'microframework';
export function socketIoLoader(settings: MicroframeworkSettings) {
const io = io();
io.useExpress(settings.getData('express_app'));
}
Application Shutdown
In the case if you want to shutdown running application you need to do following:
import { bootstrapMicroframework } from 'microframework';
import { expressLoader } from './expressLoader';
bootstrapMicroframework({
config: {
logo: 'MyApp',
showBootstrapTime: true,
bootstrapTimeout: 10,
},
loaders: [
expressLoader,
// ...
],
})
.then(framework => {
// do something before shutdown
// and shutdown everything
return framework.shutdown();
})
.then(() => {
// now everything is turned off
})
.catch(error => console.log('Application is crashed: ' + error));
All loaders which use resources should release them, for example:
TopGit's last sync did not record any GitHub topics for typestack/microframework. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on typestack/microframework?
The most recent commit recorded on typestack/microframework was 6.3 years ago, based on the GitHub push timestamp. The repository has 22 forks — one of the better signals of community interest.
How many stars does typestack/microframework have?
typestack/microframework has 73 GitHub stars — refresh the page for the live number, or check github.com/typestack/microframework. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What language is typestack/microframework written in?
typestack/microframework is written primarily in TypeScript. GitHub's language field is based on the largest share of bytes in the default branch.
Where do I read more about typestack/microframework?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/typestack/microframework is the definitive source.
Read full README in the tab above.
Want a second opinion on microframework?
Ask an AI that can read this page — one click and you get its take on microframework.