Folder Structure Conventions
.
├── build # Compiled files (alternatively `dist`)
├── docs # Documentation files (alternatively `doc`)
├── src # Source files (alternatively `lib` for library or `app` for app that doesn't need compiling)
├── test # Automated tests (alternatively `spec` or `tests`)
├── tools # Tools and utilities
├── LICENSE
└── README.md
Samples: jQuery
src
, Node.jslib
andsrc
, D3.jssrc
, AngularJSsrc
, Adobe Bracketssrc
, three.jssrc
, Expresslib
, Socket.IOlib
, Less.jslib
, Redissrc
, Acelib
, Semantic UIsrc
, Zepto.jssrc
, Emscriptensrc
, RethinkDBsrc
, Bitcoinsrc
, MongoDBsrc
, Facebook Reactsrc
, Rustsrc
, ASP.NETsrc
, SignalRsrc
, libgit2src
.
├── ...
├── test # Test files (alternatively `spec` or `tests`)
│ ├── benchmarks # Load and stress tests
│ ├── integration # End-to-end, integration tests (alternatively `e2e`)
│ └── unit # Unit tests
└── ...
Examples: jQuery, Node.js, D3.js, AngularJS, Adobe Brackets, three.js, Express, Socket.IO, Less.js, Bower, Mozilla PDF.js, Grunt, Gulp, Semantic UI, Zepto.js, Jade, RethinkDB, Vagrant, Sails.js, GitHub Hubot, Facebook React, Ansible, ASP.NET, browserify, Paper.js, Julia, Karma
.
├── ...
├── docs # Documentation files (alternatively `doc`)
│ ├── TOC.md # Table of contents
│ ├── faq.md # Frequently asked questions
│ ├── misc.md # Miscellaneous information
│ ├── usage.md # Getting started guide
│ └── ... # etc.
└── ...
Examples: HTML5 Boilerplate
doc
, Backbonedocs
, three.jsdocs
, GitLabdoc
, Underscore.jsdocs
, Discoursedocs
, Gruntdocs
, Emscriptendocs
, RethinkDBdocs
, RequireJSdocs
, GitHub Hubotdocs
, Twitter Flightdoc
, Video.jsdocs
, Bitcoindoc
, MongoDBdocs
, Facebook Reactdocs
, libgit2docs
, Stylusdocs
, Gulpdocs
, Brunchdocs