https://github.com/superfly-css/superfly-css-pli
Standard directory layout for all SuperflyCSS modules
https://github.com/superfly-css/superfly-css-pli
Last synced: about 1 year ago
JSON representation
Standard directory layout for all SuperflyCSS modules
- Host: GitHub
- URL: https://github.com/superfly-css/superfly-css-pli
- Owner: superfly-css
- License: mit
- Created: 2015-10-09T19:16:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-19T03:53:58.000Z (about 9 years ago)
- Last Synced: 2025-04-15T06:46:30.596Z (about 1 year ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SuperflyCSS Project Layout Instance
The PLI (Project Layout Instance) is a javascript object model of the standard directory layout that all [SuperflyCSS](https://github.com/superfly-css/superfly-css/) modules use. The standard layout enables users to instantly feel at home in any one of the [SuperflyCSS](https://github.com/superfly-css/superfly-css/) modules.
The PLI is inspired by the [Apache Maven Standard Directory Layout](https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html).
## Directory Descriptions
The following directories are modeled by the PLI.
### Source Directories
| Directory | Summary |
|:------------------|:----------------------------------------------------------|
| src/main/css | Entry level CSS module(s) are contained in this directory |
| src/main/js | Javascript supporting dynamic demoes |
| src/main/html | Dynamic demonstrations |
| src/main/nunjucks | Nunjucks Templates |
| src/test/css | CSS test utilities |
| src/test/js | Javascript supporting CSS unit tests |
| src/test/html | Html pages for loading the unit tests |
| src/test/nunjucks | Nunjucks Template unit tests |
### Target Directories
| Directory | Summary |
|:---------------------|:-----------------------------------|
| target/main/css | Built CSS modules |
| target/main/js | Built javascript |
| target/main/html | Built dynamic demo html pages |
| target/main/nunjucks | Precompiled Nunjucks Templates |
| target/test/css | Built test CSS utilities |
| target/test/js | Built test Javascript |
| target/test/html | Built test html |
| target/test/nunjucks | Built Nunjucks Template unit tests |
### Deploy Directories
Resources that are contained in the `deploy` directory are intended to be served by `gh-pages` for all superfly-css repositories. Resources placed in these directories are optimized by [superfly-css-task-deploy](https://github.com/superfly-css/superfly-css-task-deploy).
| Directory | Summary |
|:---------------------|:----------------------------------------|
| deploy/main/css | Deployable CSS modules |
| deploy/main/js | Deployable javascript |
| deploy/main/html | Deployable dynamic demo html pages |
| deploy/main/nunjucks | Deployable Nunjucks Templates |
| deploy/test/css | Deployable test CSS utilities |
| deploy/test/js | Deployable test Javascript |
| deploy/test/html | Deployable test html |
| deploy/test/nunjucks | Deployable Nunjucks Template unit tests |
## Extension
More directories can easily be added, and will naturally fit with the build methodology. For example:
| Directory | Summary |
|:---------------------|:---------------|
| src/main/coffescript | Coffescript |
| src/main/jade | Jade templates |