Skip to content

actuallyReallyAlex/ressie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ressie logo

Ressie

NPM Version NPM Total Downloads npm bundle size (minified + gzip) Coverage Status Build Status


A React Navbar/Sidebar combo component.

📝 Table of Contents

🧐 About

Your server assistant.

📦 Installing

NPM

npm install ressie

Yarn

yarn add ressie

🎈 Usage

Minimal Setup

import Ressie from 'ressie'

new Ressie({
  routes: [
    {
      method: 'get',
      path: '/',
      handler: (req, res, next) => {
        res.send({ result: 'success' })
      }
    }
  ]
})

// Output: "Server is listening on port 5000 ..."

Extended Setup

import Ressie from 'ressie'

new Ressie({
  middleware: [
    {
      name: 'morgan',
      options: {
        format: 'dev'
      }
    }
  ],
  port: 5000,
  routes: [
    {
      method: 'get',
      path: '/',
      handler: (req, res, next) => {
        res.send({ result: 'success' })
      }
    }
  ]
  // * Other options TBD
})

// Output: "Server is listening on port 5000 ..."

⛏️ Built Using

  • Express - Web Framework for Node.js

✏️ TODO

✍️ Author

🎉 Acknowledgements