Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oleksiyrudenko/appfs

Application Project Perfect Folder Structure
https://github.com/oleksiyrudenko/appfs

Last synced: 17 days ago
JSON representation

Application Project Perfect Folder Structure

Awesome Lists containing this project

README 

        
[2016-04-11] initiated



[2016-04-12] last major update



# APPFS = Application Project Perfect Folder Structure



Please, read [structure.md](./structure.md) to get into reasearch and

 findings.



This document describes how to **collect** and **organize** best practices and

 samples.



## Table of contents



 1. [Naming Conventions](#naming-conventions)

    * [Stencil](#stencil)

    * [Example](#example)

 1. [Contents Conventions](#contents-conventions)

    * [Files](#files)

    * [Structure explanation](#structure-explanation)

    * [Templates](#templates)

    * [Helper tools](#helper-tools)

 1. [Bonus](#bonus)



## Naming Conventions



### Stencil



1st level folder name template:



`{architecture}[--pattern][--([dateLastUpdate][--dateCheckedOn])][--source]`



**Architecture**



 * `fe` - front-end (client)

 * `be` - back-end (server)



If both supported then `fe` should be specified first, i.e. full folder 

prefix will be `febe`.



**Pattern**



Gives hint on the structuring pattern:

 * `mvc` - grouping code by responsibility: models, views, contollers, services,

    directives etc.

 * `fea` - grouping code by features: user, product, cart, vendor, common|shared,

    thus allowing you to copy-paste the feature module all at once with all its

    views, controllers etc.

 * `mix` - where both approaches employed. Please, note that services that are most 

   likely to be bound to data source rather than to a particular controller or view

   may reside in `services/` or `data/`, for e.g. This situation is not considered 

   to be a mix since

   such services are features themselves, which are just grouped by their nature

   and possibly too small to deserve personal folders.



**dateLastUpdate**



Date the source was updated last time (as of check date).



`(2014-08-18)` means that structure in the project was changed no later

than on August 18, 2014.



**dateCheckedOn**



Date the source was fetched and/or checked.



`(--2016-04-11)` means that structure was fetched or last time checked on April 11, 2016.



**Source**



Denotes briefly source project of structure, may contain hints on frameworks used 

and date the structure has been 'stolen' on.



E.g. `angular-app` means structure is fetched from angular-app project.



**[Back to top](#table-of-contents)**



### Example



`fe--fea--(2014-08-18--2016-04-11)--angular1Material`:



 * front-end only, 

 * feature pattern, 

 * source last updated on August 18, 2014

 * latest check/fetch on April 11, 2016

 * sourced from angular-material project

 

More details on source project can be found in APPFS.md in that folder.



**[Back to top](#table-of-contents)**



## Contents Conventions



### Files



Folders may contain also files or file stubs. These are either minimally required for project

and/or back some filenaming conventions.



**[Back to top](#table-of-contents)**



### Structure explanation



Project root folder must contain `APPFS.md` describing source in more details.



It may contain folder structure or alternatively refer to

`APPFS-tree.md`, which must contain complete or partial folder structure.

If structure reflected is partial then relevant notice required.



Any sub-folder may also contain explaining `APPFS.md` and/or `APPFS-tree.md`.

If so, then it is reasonable to have relevant references in parent folder's

`APPFS.md` and/or `APPFS-tree.md`.



**[Back to top](#table-of-contents)**



#### Templates



Use `APPFS-template.md` as a template for `APPFS.md`.



**[Back to top](#table-of-contents)**



#### Helper tools



Use `mktree.bat` to generate `APPFS-tree.md` under Windows.



Usage: `mktree.bat` `"target-folder-path"` -- quote folder name! It's Windows!



NB! `mktree.bat` generates complete structure.

There is no option to limit depth of scan.

The result requires minor fixes (excessive lines removal).



**[Back to top](#table-of-contents)**



* * *



## Bonus



### Project files templates



[README: Adnroid/iOS, gh-pages, general, simple scripts; LICENSE; TODO; LIBRARIES](https://github.com/repat/README-template)



[README: general application](https://github.com/stephzilla/readme)



[README; MIT LICENCE; CHANGELOG](https://github.com/kud/README-template)



**[Back to top](#table-of-contents)**