# rddx-express

> Express.js base project for REPL drive development

Latest version **0.0.1** (published 2015-12-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install rddx-express
pnpm add rddx-express
yarn add rddx-express
bun add rddx-express
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-12-18 |
| First published | 2015-12-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Zongmin Lei |
| Maintainers | leizongmin |
| Keywords | repl, express, hotreload |

## Links

- npm: https://www.npmjs.com/package/rddx-express
- Repository: https://github.com/leizongmin/rddx-express
- Homepage: https://github.com/leizongmin/rddx-express#readme
- Issues: https://github.com/leizongmin/rddx-express/issues
- npm.io page: https://npm.io/package/rddx-express

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [rddx-mod](https://npm.io/package/rddx-mod.md) 0.0.6
- [lei-utils](https://npm.io/package/lei-utils.md) ^1.1.0

## Recent versions

- 0.0.1 (latest) — 2015-12-18

## README

# rddx-express
Express.js base project for REPL drive development

## Installation

**For Node v4.0.0 or above**:

```bash
$ npm install rddx-express express@4.x --save
```

**Notes: `rddx-express` doesn't include `express` module, so you need to install it by youself.**

## Usage

### Example files

launch file `app.js`:

```javascript
'use strict';

const path = require('path');
const project = require('rddx-express');

// required options
project.set('path', __dirname);
project.set('port', 3000);

// development mode options
project.set('mod reload', true);         // enable hot reload
project.set('uncaught exception', true); // catch uncaughtException
project.set('repl', true);               // start a REPL

// register module
project.register('init', './init.js');
project.register('router.default', './routes/index.js');
project.register('router.admin', './routes/admin.js');

// events
project.on('reload', file => {
  console.log(`reload file: ${file}`);
});
project.on('init', app => {
  console.log(`inited`);
});

// start listening
project.listen(err => {
  console.log(`start failed: ${err}`);
});
```

init express file `init.js` **(support hot reload)**:

```javascript
'use strict';
const path = require('path');
const express = require('express');
const serveStatic = require('serve-static');
const ejs = require('ejs');

module.exports = function (project) {

  let app = express();

  app.set('views', path.resolve(__dirname, 'views'));
  app.set('view engine', 'html');
  app.engine('html', ejs.__express);
  app.use('/assets', serveStatic(path.resolve(__dirname, 'assets')));
  app.use('/admin', project.router('admin'));
  app.use('/', project.router('default'));

  // return an express instance
  return app;

};
```

register routes file `routes/index.js` **(support hot reload)**:

```javascript
'use strict';

module.exports = function (project, mod, router) {

  // register hot reload module
  mod.register('home', './home.js');
  mod.register('user', './user.js');

  router.get('/', mod('home').index);
  router.get('/list', mod('home').list);

  router.get('/user', mod('user').index);
  router.get('/signup', mod('user').signup);
  router.get('/login', mod('user').login);

};
```

routes handle file `routes/home.js` **(support hot reload)**:

```javascript
'use strict';

const project = require('rddx-express');

exports.index = function (req, res, next) {
  res.render('index');
};

exports.list = function (req, res, next) {
  res.render('list');
};
```

### Start development

run `app.js` to start:

```bash
$ node app.js
```

Notes: when the **(support hot reload)** file has been changed, and option `mod reload` is set to `true`, will automatically reload it.

For file `init.js`, generally does not support hot reload. If you want to make some change, for example, register a new router:

first step, create a new file `routes/admin.js` (like above file `routes/index.js`);

the next, just type you register code in REPL:

```javascript
[rddx-express]> project.register('router.admin', './routes/admin.js');
```

Notes: in REPL, you can use variable name `$project` to access the project instance.

### Production deploy

delete the below lines in file `app.js`:

```javascript
// development mod
project.set('mod reload', true);         // enable hot reload
project.set('uncaught exception', true); // catch uncaughtException
project.set('repl', true);               // start a REPL
```

## License

```
The MIT License (MIT)

Copyright (c) 2015 Zongmin Lei <leizongmin@gmail.com>
http://ucdok.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

---
_Source: https://npm.io/package/rddx-express · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._