Skip to content

Instantly share code, notes, and snippets.

@paulolorenzobasilio
Created January 9, 2020 01:44
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
Star You must be signed in to star a gist
Save paulolorenzobasilio/eda93e7bbd0503db905bec2b78d9376c to your computer and use it in GitHub Desktop.
Adding directory structure on readme

Directory Structure

Aerobatic defaults to some specific common front-end conventions. By conforming to these conventions you can simplify your configuration (convention over configuration).

Here is the basic suggested skeleton for your app repo that each of the starter templates conforms to:

├── app
│   ├── css
│   │   ├── **/*.css
│   ├── favicon.ico
│   ├── images
│   ├── index.html
│   ├── js
│   │   ├── **/*.js
│   └── partials/template
├── dist (or build)
├── node_modules
├── bower_components (if using bower)
├── test
├── Gruntfile.js/gulpfile.js
├── README.md
├── package.json
├── bower.json (if using bower)
└── .gitignore

Your app's source code is nested beneath the app directory. This is where assets are served from in debug mode. Note that in most cases it is not necessary to setup a watch to re-compile languages and syntaxes including CoffeeScript, Sass, Stylus, Jade, and LESS as the development server will automatically do this for you in middleware. Note that in your index page, you should not include the /app prefix since the development asset server will treat it as the root.

<!- Serves app/js/main.js-->
<script data-aero-build="debug" src="/js/main.js"></script>

For deployment, yoke assumes that all the files (including the index page) required to run in release mode have been written to a directory called either dist or build off the root. Grunt or Gulp both have good facilities for writing the outputs of a task to a different directory.

https://raw.githubusercontent.com/aerobatic/markdown-content/master/docs/directory-structure.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment