Skip to content

FOLDER-STRUCTURE.md

Latest commit

 

History

History
63 lines (55 loc) · 2.15 KB

FOLDER-STRUCTURE.md

File metadata and controls

63 lines (55 loc) · 2.15 KB

Folder structure being followed

All the core and common stylesheets (.css), fonts (.ttf, .otf), image (.jpg, .png, ..), javascript (.js) and sass (.scss) files are placed inside the assets folder. Sub-folders can be created inside these directories for better management.

  ROOT
    |- assets
      |- css/
      |- fonts/
      |- img/
      |- js/
      |- vendor [optional folder to store 3rd party css, js or plugins]
        |- css
        |- js
      |- sass/

All files containing necessary (minimum required for this repository to run on a local server) table structures (.sql, ..) are placed inside sql folder.

  ROOT
    |- sql/

All files performing database operations or server-side operations are placed inside server folder. Sub-folders can be created inside this directory for better management.

  ROOT
    |- server/

A new web page can be made at ROOT level or a group of similar webpages inside a separate folder at ROOT level.

  Example:
  ROOT
    |- index.html (single web page at ROOT level)

   OR

   ROOT
    |- dashboard (group of similar webpages inside a separate directory)
      |- index.html
      |- similar-webpage.html
      |- another-page.html
      
   TIP: When using a separate folder, additional css and js folders may be created inside this directory
   specially for the web pages inside the directory
   Example:
   ROOT
    |- dashboard
      |- css/
      |- js/
      |- index.html
      |- similar-webpage.html

Files that are common to other files (or which are needed to be included in other pages) are stored inside includes folder.

  ROOT
    |- includes/
    |- dashboard
      |- includes/ (can also be made inside a directory exclusively for the files inside the directory)