Node Express MySQL Scaffolding Overview

There are many node scaffoldings based on Mongoddb, but MySQL is rare. This is a simple scaffolding built on express and mysql.

node-express-mysql-scaffolding
[more…]

Features

1. Register with fullname,username, email, passord, very simple
2. Login with passport-local strategy
3. Twitter Bootstrap Support
Note: I just want keep the scaffolding clean, no more complex function, and keep it flexible.

Install

NOTE: You need to have node.js, MySQL Server installed

1. Clone the project
[shell]
$ git clone https://github.com/lgrcyanny/node-express-mysql-scaffolding.git
$ npm install
$ cp config/config.disk.js config/config.js
[/shell]
Please config your MySQL in the config.js;

2. Install MySQL server

3. Start MySQL service

4. Build the database
[shell]
$ mysql -u root -p
> create database scaffolding
> quit
$ mysql -u root -pyourpassword scaffolding < scaffolding.sql
[/shell]

5. Start Node.js Server
[shell]
$ npm start
[/shell]

6. Then visit http://localhost:3000/

Thanks to node-express-mongoose-demo, it’s a great scaffolding, but it still took me 2 days to migrate from MongoDB based scaffolding to MySQL scaffolding, and the node-express-mongoose-demo has too many Login Support which is too complicated.

Directory structure

-app/
|controllers/
|
models/
|mailer/
|
views/
-config/
|routes.js
|
config.js
|passport.js (auth config)
|
express.js (express.js configs)
|__middlewares/ (custom middlewares)
-public/

Tests

Tests are not shipped now, I will write tests later.
[shell]
$ npm test
[/shell]

License

(The MIT License)