nodejs-scaffold

A Node.js scaffolding for a web client with Express.js. We hope you write a good README file for your project ;-)

How to run this application

Please check that you have Node.js installed with npm. If you don't know where to start check https://nodejs.org/.

The ".env" file must exist to configure a server-side session with browsers (Please check express-session module. You can start with our example:

cp .env.example .env

Then run what a usual Node.js application needs:

npm install
npm run build

You can run the tests with:

npm test

Finally, run our application:

node server.js

Information to start developing from this code

What modules are we using, mainly?

• Express;
• Pug;
• Mocha;
• Gulp, and;
• Sass related modules.

This code is following development rules and styles with jshint and ESLint. Check commented code to enable integration with Mongo DB via mongoose.

Using Docker

If you want to run this project with Docker:

cp .env.example .env
docker-compose build
docker-compose up

It will setup docker and run the application on http://localhost:3000.

You can run tests with:

docker-compose run web npm test