├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Node best practices 2 | 3 | Best practices for creating Node backends. 4 | 5 | ## Node version 6 | 7 | You should generally use the latest LTS version (even version numbers) of Node, 8 | or the latest stable version (odd version numbers) if you can update quickly. 9 | 10 | You can check the LTS schedule and process at [nodejs/LTS](https://github.com/nodejs/LTS#lts-schedule1). 11 | 12 | Create a `.nvmrc` file to specify what Node version your project is using. 13 | Keep the range open to allow updating to newer minor and patch releases. 14 | You might also want to add your Node version to the `engines` object in `package.json`. 15 | 16 | echo 6 > .nvmrc 17 | 18 | ## Adhere to twelve-factor principles 19 | 20 | To create scalable services you should adhere to the [twelve-factor principles](https://12factor.net/) when possible. 21 | This is doubly more important with Node because scaling mostly happens by adding more instances. 22 | 23 | One of the 12-factor principles is keeping configuration in environment variables. 24 | Locally you should use [`dotenv`](https://github.com/motdotla/dotenv) to manage your environment variables. 25 | 26 | ## Use yarn and `yarn.lock` to handle dependencies 27 | 28 | Use [`yarn`](https://yarnpkg.com/en/) to manage your project's dependencies. 29 | You can ensure that your dependencies are up-to-date by just running `yarn` in your project folder without needing to run separate `npm install`, `npm update`, `npm dedupe` and `npm prune` commands. 30 | 31 | Check the `yarn.lock` file in to your repo to ensure reproducable dependencies across machines. 32 | When doing that you should update, or even recreate, the lock file regularly. 33 | You really want to have the latest minor and patch versions with bug fixes and security updates. 34 | You can use [Snyk](https://snyk.io/) to find vulnerable dependencies. 35 | 36 | Properly evaluate all new dependecies before adding them. 37 | The scoring system of [npms](https://npms.io/) is one way to assess if a package can be depended upon. 38 | The score is based on quality, popularity, maintenance and personalities. 39 | See the [npms documentation](https://github.com/npms-io/npms-analyzer/blob/master/docs/architecture.md#evaluators) for more information and to learn how to evaluate packages yourself. 40 | 41 | You can use Yarn's `yarn upgrade-interactive` command to see which dependencies have new versions available – these may be breaking, so be sure to run your test suite after upgrading. 42 | 43 | ## NODE_ENV 44 | 45 | Always set the `NODE_ENV` environment variable to one of `development`, `test` or `production`. No other values should be used. 46 | If you need to differentiate between different deployed environments use a different environment variable like `APP_ENV`. 47 | All deployed environments should have `NODE_ENV` set to `production`. 48 | 49 | ## Only use JavaScript features supported by Node 50 | 51 | Use the CommonJS module system native to Node instead of ES2015 modules. 52 | Node doesn't have support for ES2015 modules and you shouldn't add a build step to your backend just for module support. 53 | Node 6+ has good support for most of other Javascript features – you can check the status of support at [node.green](http://node.green/). 54 | Using vanilla Node makes debugging and development a lot smoother. You also get proper stack traces with no extra effort. 55 | 56 | ## Use strict mode in all files 57 | 58 | The flip-side of not using ES2015 modules is that you don't get strict mode for free. 59 | Strict mode needs to be enabled in all files with the `"use strict";` statement at the top. 60 | 61 | You can enforce strict mode usage with ESLint and add strict mode statements using [use-strict-cli](https://github.com/philidem/use-strict-cli). 62 | 63 | Don't use Node's `--strict_mode` flag, as that enables strict mode also for external dependencies (which may not be `use strict` compatible). 64 | 65 | ## EditorConfig 66 | 67 | Use [EditorConfig](http://editorconfig.org/) for editor independent configuration. 68 | 69 | ```ini 70 | # .editorconfig 71 | root = true 72 | 73 | [*] 74 | # Change these settings to your own preference 75 | indent_style = space 76 | indent_size = 2 77 | 78 | # We recommend you to keep these unchanged 79 | end_of_line = lf 80 | charset = utf-8 81 | trim_trailing_whitespace = true 82 | insert_final_newline = true 83 | 84 | [*.md] 85 | trim_trailing_whitespace = false 86 | ``` 87 | 88 | ## Use ESLint 89 | 90 | Use [ESLint](http://eslint.org/) to catch common mistakes. 91 | The [`eslint:recommended`](http://eslint.org/docs/rules/) ruleset makes for a good starting point. 92 | 93 | ```js 94 | { 95 | "parserOptions": { 96 | "ecmaVersion": 2015, 97 | "sourceType": "script" 98 | }, 99 | "env": { 100 | "node": true 101 | }, 102 | "extends": "eslint:recommended", 103 | "rules": { 104 | "strict": "error" 105 | } 106 | } 107 | ``` 108 | 109 | ## Use prettier 110 | 111 | Use [prettier](https://github.com/prettier/prettier) for consistent code style in your project. 112 | Prettier automatically formats code and removes the need for code style guides and bikeshedding related to it. 113 | You can enforce usage of prettier style with [`eslint-plugin-prettier`](https://github.com/not-an-aardvark/eslint-plugin-prettier). 114 | --------------------------------------------------------------------------------