adam-l / genesis

More then a front-end boilerplate, less then a framework.

Genesis

Wise beginning of your next project

Features

• EditorConfig file ensuring consistent formatting is preserved
• other

Browser support

IE9+

Directory structure

This section describes the project layout provided by Genesis.

├── config/
│
├── dist/
│
├── docs/
│   └── resources/
│
├── node_modules/
│
├── scripts/
│
├── src/
│   ├── components/
│   │
│   ├── fonts/
│   │
│   ├── images/
│   │
│   ├── media/
│   │
│   ├── scripts/
│   │   ├── _coffeescript/
│   │   │
│   │   └── javascript/
│   │
│   ├── stylesheets/
│   │   ├── _scss/
│   │   │
│   │   └── css/
│   │
│   └── templates/
│       ├── _swig/
│       │
│       └── html/
│
├── temp/
│
└── vendor/

config
This folder should be used to hold the configuration files for your project.

Paths used in Gulp tasks are defined in gulp-paths.js file that is stored here.

Some files such as EditorConfig or Travis configuration file are obvious exeception and are going to be stored in the root folder of the project.

dist
This folder should be used only for deployment - making changes directly to the files located here is not recommended. Production files in this folder are generated from the source files located in the src folder. By default this folder is not tracked by the version control system.

The role of this folder is similiar to the role of folders often named public, build or static in other projects.

docs
Use this folder to store documentation for the project. Different file formats can be used for documentation, for example: md, rst, html, pdf, doc. This folder can also contain graphic files.

docs/resources
Any materials provided by stakeholders - logos, style guides, page layouts, project briefings and so on. In many cases this folder is going to contain graphic design files in the format of psd.

src
The folder contains all the assets source files. This is where all development work is done. Compiled files are generated (either automatically or manually) in the distribution folder where they are waiting for deployment.

You may find this folder similiar to the assets folder in popular frameworks such as Rails, Sails.js or Play.

Not what you were looking for?

You were probably looking for this: