octoris

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #go #android #deep-learning #java #windows #cli #kubernetes #awesome-list #security #open-source

(★ 9)

A small and simple node server framework.

octoris Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

A small and simple node server framework.

## Install

```
npm i octoris
```

## Usage

Create a basic server:
```js
const { listen } = require('octoris')
const routes = require('./routes')

listen({ port: 3000 }, routes)
  .then(addr => console.log(`Server Listening on ${addr}`))
  .catch(console.error)
```

routes.js:
```js
const { router, response, methods } = require('octoris')
const { send } = response
const { route, fixed, composeRoutes } = router
const { GET } = methods

function homeHandler () {
  return send(200, 'Hello Home!')
}

function aboutHandler () {
  return send(200, 'Hello About!')
}

const home = route([fixed('home')], [
  GET(homeHandler)
])

const about = route([fixed('about')], [
  GET(aboutHandler)
])

module.exports = composeRoutes({ logger: true }, [about, home])
```

## Documentation

You can find the documentation [here](https://octoris.gitbook.io/octoris)

## Official Middleware

Here is a list of official released middleware for Octoris

- [serve-static](https://github.com/octoris/serve-static)
- [body-parser](https://github.com/octoris/body-parser)
- [multipart](https://github.com/octoris/multipart)

## Contribute

[Checkout the contribute file here](https://github.com/dhershman1/octoris/blob/master/.github/CONTRIBUTING.md)

Please check this file regularly as it is **Subject to change** and **updated** as the project continues to develop and grow!

octoris

octoris Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

octoris

octoris Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README