archives/kirbe
1
0
Fork 0
mirror of https://github.com/Wessel/kirbe.git synced 2026-07-14 20:43:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improvements to middleware

Browse Source
This commit is contained in:
Wessel T
2019-01-17 17:30:09 +01:00
parent 928c51432e
commit b9ae3293d7
9 changed files with 71 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -30,7 +30,7 @@ $ npm i kirbe # Install w/ NPM
#### Start a HTTP(s) server on port 8080 and add some routes
```js
const kirbe = require( 'kirbe' ); // Define kirbe
const app = new kirbe(); // Make your kirbe client
const app = new kirbe(); // Make your kirbe instance
app.route( '/bear', 'GET', ( req, res ) => res.status( 200 ).body({ 'bear': 'cop' }) );
app.route( ( req, res ) => res.status( 404 ).body( 'Error: Content not found!' ).end() );
@@ -46,19 +46,21 @@ const https = require( 'https' ); // This should be at the top of your code
https.createServer( app.externalHandler ).listen( 8080 );
```
## Default extensions ( [/extensions](extensions) )
## Default extensions ( [/model/middleware](model/middleware) )
#### Static
> Host static files on your website
Host static files on your website
##### Usage
```js
const path = require( 'path' ); // Define path
const kirbe = require( 'kirbe' ); // Define kirbe
const app = new kirbe(); // Make your kirbe client
const app = new kirbe(); // Make your kirbe instance
app.use( kirbe.static( path.join( __dirname, 'static' ) ) );
```
### Creating your own
If you want to add your own extension/middleware, you can either create your own module or add it to the [/model/middleware](model/middleware) and then create a pull request!
### Why use kirbe?
Kirbe is a lightweight and fast HTTP server library, especially comparing to express and connect which are around 1mb in size with multiple dependencies. If you want any features that aren't inside of Kirbe yet, you can open an issue or pull request.