Express app example.

Live demo

Introduction

Motivation

When I began an project personal, I had very problems for integrate diferents modules for login, i18n, send email, ORM, validate input data, test unit, enviroment variables, generate documentation, minified files, check code format and syntax, etc.

Finally I could it solutions reviewing documentation officials, GitHub, StackOverflow and differents web site.

I hope that this example or part of it to be util for the community.

Sure that this example could improve and to be complete with more functionality. Are welcome suggestions, ideas, bugs identified, and colaborations. Greetings!

Included modules

• bycript: Hash password.
• ejs: View engine.
• emailjs: Send emails.
• express-i18n and geolang-express: For support i18n. Languages includes: ES and EN.
• mysql2: Driver for MySQL.
• passport: Login and Signup with providers internal and externals (Google, Facebook and Twitter).
• req-flash: Flash messages.
• sequelize: ORM.
• socket.io: Chat and realtime options.
• validate.js: Validate input data.
• winston: Generate log.
• crypto: Module Node.js for generate tokens.

Modules dev

• dotenv and dotenv-safe: Load .env file.
• eslint: Verify code format and syntax.
• grunt-contrib-cssmin: Minimize css files.
• grunt: Automatization of task.
• jsdoc: Generate documentation.
• mocha: Test unit.
• supertest and supertest-session: Complement for unit test.
• uglify-es: Minimize js files.

Setup

Requeriments

• Node.js
• A database MySQL

Installation

$ npm install express-demo

Configuration

Create a file .env based on .env.example and add settings:

• Port.
• Name app.
• Database.
• Session.
• Bcrypt salt.
• Email.
• Login social (Optional).

Quick Start

The scripts is configured in the file package.json

"scripts": {
    "start": "node ./bin/www",
    "start-dev": "NODE_ENV=development node ./bin/www",
    "test": "NODE_ENV=development mocha ./test/*.js",
    "test-navigation": "NODE_ENV=development mocha test/navigation.js",
    "grunt": "grunt",
    "sequelize": "sequelize
},

For to start the server for development enviroment:

$ npm run start-dev

And to run the test suite on development enviroment:

$ npm test

Notes Additionals

Features

• Login on form.
• Login with Google, Facebook and Twitter. (Optional)
• Signup.
• Forgot password.
• i18n.

Features dev

• Unit test. npm test
• Generate documentation: npm run grunt jsdoc. Documentation generated in doc folder.
• Check format and syntax code: npm run grunt exec:eslint. If exists erros, look log/eslint.log file.
• Minimize public/js/general.js file: npm run grunt exec:minGeneral. File generated: public/js/general.min.js.
• Minimize public/css/main.css file: npm run grunt cssmin. File generated: public/css/main.min.js.
• ORM Sequelize, example to create seeder: npm run sequelize seed:generate -- --name "user-insert-test". File generated: db/seeder/20171122140352-user-insert-test.js.

Or only npm run grunt for run all tasks. Look Gruntfile.js for more tasks details.

Social login (Optional)

Create an app on Google, Facebook or Twitter and set in the file .env

For example for Facebook:

FB_ID=YourFacebookAppID
FB_SECRET=YourFacebookAppSecret
FB_SCOPE=email
FB_CALLBACK=http://localhost:3000/auth/facebook/callback

For reduce code, others callbacks follow same patter. For example:

FB_CALLBACK=http://localhost:3000/auth/facebook/callback
GG_CALLBACK=http://localhost:3000/auth/google/callback
TW_CALLBACK=http://localhost:3000/auth/twitter/callback

Finally

People

Author: alditis

If this project help you some and you want support me, you can give me a donate. Thanks!

       

License

MIT