Skip to content
Add express routes to your nuxt app
Branch: master
Clone or download
Latest commit 3b561b6 Apr 7, 2018

README.md

nuxt-express-module

npm (scoped with tag) npm CircleCI Codecov Dependencies js-standard-style

📖 Release Notes

Features

Provides express and express/routes directory to write express routes within nuxt. The module will watch for all files within the express directory for changes and hot-reload without taking down the entire nuxt server.

Setup

  • Add nuxt-express-module dependency using yarn or npm to your project
  • Add nuxt-express-module to modules section of nuxt.config.js
{
  modules: [
    // Simple usage
    'nuxt-express-module',

    // With options
    ['nuxt-express-module', { /* module options */ }],
 ]
}
// express/routes/index.js sample
const {Router} = require('express')
const router = Router()

router.get('/api/test', (req, res) => {
  res.send('hello')
})

module.exports = router

Options

expressPath

Overrides the default path of where the express directory is

routesPath

Overrides the default path of where express/routes/index.js is located

Usage

Module Description

Development

  • Clone this repository
  • Install dependnecies using yarn install or npm install
  • Start development server using npm run dev

License

MIT License

Copyright (c) James Lee uptownhr@gmail.com

You can’t perform that action at this time.