Skip to content

SME-FE/sme-router

Repository files navigation

SME Router

A lightweight router lib that implement with express route style

Travis branch coverage download version license

Languages

Documentation

Get Start

Installation

npm i --save sme-router

Usage

Edit sme-router example

index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>SME Router</title>
</head>
<body>
  <div id="app">
    <div id="router-view"></div>
  </div>
</body>
</html>
import SMERouter from 'sme-router'

const router = new SMERouter('router-view')

// route config
router.route('/index', (req, res, next) => {
  res.render(
    `hallo world`
  )
})

router.route('*', (req, res, next) => {
  res.redirect('/index')
})

Note: if your are not using webpack, your can simply import it to your html file

<script type="text/javascript" src="https://unpkg.com/sme-router"></script>

Please see the document for more details

Live demo

click me to see the demo

Running Example

1.clone the repo

npm i
npm run dev

open http://localhost:8080/

2.Test

npm run test // or => karma start

3.lint

npm run lint

Contributors

Thanks goes to these wonderful people (emoji key):


hwen

🤔 💻 🎨 📖 💡

License

MIT License

Copyright (c) 2017-present, hwen hwenleung@gmail.com