search

caxy / front-end-starter-kit

Caxy's Front End Starter Kit -- Backend: https://github.com/caxy/symfony-starter-kit --
https://www.caxy.com
MIT License
3 stars 2 forks source link

Root Project Structure Proposal (#1) #7

Closed jschroed91 closed 7 years ago

jschroed91 commented 7 years ago

Proposal for #1

Proposed Root Project Structure

.
├── bin                      # Build/Start scripts
├── dist                     # The folder for the compiled output (ignored by git)
├── docs                     # (optional) Documentation files for the project
├── config                   # Project and build configurations
├── public                   # Static public assets (not imported anywhere in source code)
├── server                   # Node server application that provides a http server for development (optional)
│   └── main.js              # Server application entry point
├── src                      # Application source code
│   ├── styleguide           # Assets used in the styleguide that are not used in the application 
│   │   └── pattern-markup   # HTML partials for the styleguide referenced via KSS
│   ├── styles               # Application styles
│   ├── index.html           # Main HTML page container for app
│   └── main.js              # Application bootstrap and rendering
│── tests                    # Unit tests
└── package.json             # The list of 3rd party libraries and utilities

I took some liberties on also defining src/index.html and src/main.js here - we're going to need to define a entry template and JS file when we implement a build tool, so I went for it now.

Also, @beckkramer - does src/styles make sense, or were you thinking something else?

beckkramer commented 7 years ago

src/styles makes sense to me. In the instance of a project that also has a styleguide, we could do one of two things:

jschroed91 commented 7 years ago

@beckkramer Ooo, what is your preference? The second option is very appealing to me, but not sure if there are trade offs?

jschroed91 commented 7 years ago

After discussing with @beckkramer - we are going with option 2 from above as the preferred approach, and we will incorporate support for the styleguide as part of the starter kit.

This means I'll be adding more to this root project structure shortly

jschroed91 commented 7 years ago

@beckkramer @caxy/caxy-front-end-developers Alright - updated the root project structure to include:

src/styles src/styleguide src/styleguide/pattern-markup

Looking for further review and approval