A guide to the configuration files for projects: where they live and what they do.
-
.editorconfig
: Sets the default configuration for certain files across editors. (e.g. indentation) -
.gitattributes
: Normalizes howgit
, the version control system this boilerplate uses, handles certain files. -
.gitignore
: Tellsgit
to ignore certain files and folders which don't need to be version controlled, like the build folder. -
.travis.yml
andappveyor.yml
: Continuous Integration configuration
This boilerplate uses Travis CI for Linux environments and AppVeyor for Windows platforms, but feel free to swap either out for your own choice of CI. -
package.json
: Ournpm
configuration file has three functions:- It's where Babel and ESLint are configured
- It's the API for the project: a consistent interface for all its controls
- It lists the project's package dependencies
Baking the config in is a slightly unusual set-up, but it allows us to keep the project root as uncluttered and grokkable-at-a-glance as possible.