Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save mateusvahl/be7233cdfec357fe73b9 to your computer and use it in GitHub Desktop.
Save mateusvahl/be7233cdfec357fe73b9 to your computer and use it in GitHub Desktop.
For JS:
+ /project-root
|--+ /dist Packaged stuff
|--+ /build Compiled stuff
|--+ /bin Sometimes these things have executables
|--+ /src Source stuff
| |--+ /stylus
| |--+ /scripts All JavasScript/LiveScript stuff
| | |--+ index.js Entry point to the application
| | `--+ /modules When it doesn't quite make sense to split as separated NPM repos
| |--+ /images
| |--+ /fonts
| `--+ /resources Other resources
|--+ /docs Documentation stuff
| |--+ /specs Specification |
| |--+ /design Design documents |-> This is usually just Markdown
| |--+ /api API reference |
| `--+ /guide Other guides |
|--+ /tools Anything related just to this project we need to automate
|--+ /vendor All the stuff we grab from elsewhere
|--+ /test Testing stuff
| |--o tap.ls Tap-based reporter
| `--+ /specs All property-based and example-based specifications
|--+ /node_modules All dependencies
|--o README.md Entry point information (installing, compiling, etc)
|--o package.json Entry point meta-data
|--o Makefile/Gulpfile/Gruntfile
|--o .hgignore Things we don't want in the repository
`--o .npmignore Things we also don't want in our private NPM repository
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment