Express app example.
Motivation
When I began an project personal, I had very problems for integrate diferents modules for login, i18n, send email, ORM, 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!
Live demo
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: Vaidate data input.
- 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.
Requeriments
Enviroment
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": ,
For to start the server for development enviroment:
$ npm run start-dev
And to run the test suite on development enviroment:
Note: First must edit the file test/util/data-test.js
putting your test data.
$ npm test
Run Grunt local (Default)
node_modules/.bin/grunt
Run Grunt global (Optional)
First install globaly:
sudo npm i -g grunt-cli
Then to call Grunt is grunt
directly.
Note: This too can considered for: sequelize-cli
Features
- Login on form.
- Login with Google, Facebook and Twitter. (Optional)
- Signup.
- Forgot password.
- i18n.
Features dev
Note: Considering Grunt global for simplicity.
- Unit test.
- Generate documentation:
grunt jsdoc
. Documentation generated indoc
folder. - Check format and syntax code:
grunt exec:eslint
. If exists erros, looklog/eslint.log
file - Minimize
public/js/general.js
file:grunt exec:minGeneral
. File generated:public/js/general.min.js
- Minimize
public/css/main.css
file:grunt cssmin
. File generated:public/css/main.min.js
Or only grunt
for run all tasks. Look Gruntfile.js
for more details.
Social login (Optional)
Create an app on Google, Facebook or Twitter and set in the file .env
For example for Facebook:
FB_ID=YourFacebookAppIDFB_SECRET=YourFacebookAppSecretFB_SCOPE=emailFB_CALLBACK=http://localhost:3000/auth/facebook/callback
For reduce code, others callbacks follow same patter. For example:
FB_CALLBACK=http://localhost:3000/auth/facebook/callbackGG_CALLBACK=http://localhost:3000/auth/google/callbackTW_CALLBACK=http://localhost:3000/auth/twitter/callback
People
Author: alditis
If this project help you some and you want support me, you can give me a donate. Thanks!