kumarabhirup / nodejs-boilerplate

Complete NodeJs, Express server boilerplate with Sass and Linting!

🍛 nodejs-boilerplate

📦 Setup

🖥️ Development environment

• Run

$ git clone https://github.com/KumarAbhirup/nodejs-boilerplate <PROJECT_NAME>
$ cd <PROJECT_NAME>
$ npm i
$ npm run dev

• Visit http://localhost:3001/

🎷 SASS usage

• Dump all your .scss files in src/public/assets/styles.
• Run npm run gulp to generate minified CSS files.
• While styling, use npm run gulp:watch, for live compilation.

⚒️ Linting

In VSCode

• Install ESLint and Prettier VSCode extensions.
• Done! Now you have live linting and autofixing setup!

In Any other IDE

• Run npm run lint to check for linting errors.
• Run npm run lint:fix to fix the linting errors.

🦄 Info

• The entrypoint for the app is src/server/index.js. App uses ExpressJs. Do your custom server, APIs and routing from there. Learn more
• The src/public directory is served on http://localhost:3001/public.
• Store your html templates in src/public directory.
• Supports only .scss files for compilation.
• To customize the linter, use .eslintrc and .prettierrc file. Learn more

📝 License

MIT - Source code by Kumar Abhirup

Follow me 👋 on Twitter →