From adb3ce8ebed256c5861fc46131e48b241606a725 Mon Sep 17 00:00:00 2001 From: beckkramer Date: Tue, 17 Jan 2017 16:41:46 -0600 Subject: [PATCH 1/8] Adds starting folders and readme files. --- src/styles/patterns/base/README.md | 3 +++ src/styles/patterns/containers/README.md | 3 +++ src/styles/patterns/layouts/README.md | 3 +++ src/styles/patterns/pages/README.md | 7 +++++++ src/styles/vendor/README.md | 9 +++++++++ 5 files changed, 25 insertions(+) create mode 100644 src/styles/patterns/base/README.md create mode 100644 src/styles/patterns/containers/README.md create mode 100644 src/styles/patterns/layouts/README.md create mode 100644 src/styles/patterns/pages/README.md create mode 100644 src/styles/vendor/README.md diff --git a/src/styles/patterns/base/README.md b/src/styles/patterns/base/README.md new file mode 100644 index 0000000..f1ceef6 --- /dev/null +++ b/src/styles/patterns/base/README.md @@ -0,0 +1,3 @@ +# Base + +TODO: Outline what qualifies as a 'base' pattern. \ No newline at end of file diff --git a/src/styles/patterns/containers/README.md b/src/styles/patterns/containers/README.md new file mode 100644 index 0000000..b4017f4 --- /dev/null +++ b/src/styles/patterns/containers/README.md @@ -0,0 +1,3 @@ +# Containers + +TODO: Outline what qualifies as a 'container' pattern. \ No newline at end of file diff --git a/src/styles/patterns/layouts/README.md b/src/styles/patterns/layouts/README.md new file mode 100644 index 0000000..165ae0c --- /dev/null +++ b/src/styles/patterns/layouts/README.md @@ -0,0 +1,3 @@ +# Layouts + +TODO: Outline what qualifies as a 'layout' pattern. \ No newline at end of file diff --git a/src/styles/patterns/pages/README.md b/src/styles/patterns/pages/README.md new file mode 100644 index 0000000..b8a1095 --- /dev/null +++ b/src/styles/patterns/pages/README.md @@ -0,0 +1,7 @@ +# Pages + +A pages folder will not always be needed, and restraint should be used +in leveraging it. The most likely case of it being needed will be in the +event the homepage of a site is drastically different from other pages. + +TODO: Outline what qualifies as a 'page' pattern. \ No newline at end of file diff --git a/src/styles/vendor/README.md b/src/styles/vendor/README.md new file mode 100644 index 0000000..43d2081 --- /dev/null +++ b/src/styles/vendor/README.md @@ -0,0 +1,9 @@ +# Vendor Styles + +Optional folder. + +In cases where third party CSS needs to be included in the source files +of a project, this is where that third party code should go. + +However, it's strongly recommended to leverage npm or yarn to include +third party code that way instead. \ No newline at end of file From 65aae973ff01c5e46ad50d3630ba16b46bf97382 Mon Sep 17 00:00:00 2001 From: beckkramer Date: Tue, 17 Jan 2017 16:52:26 -0600 Subject: [PATCH 2/8] Adds base folder README. --- src/styles/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 src/styles/README.md diff --git a/src/styles/README.md b/src/styles/README.md new file mode 100644 index 0000000..9708d38 --- /dev/null +++ b/src/styles/README.md @@ -0,0 +1,9 @@ +# Project CSS + +## Naming Conventions: BEM + +TODO: Outline what BEM is and how to use/extend classes using it. + +## Recommendations on Folding In Third Party CSS + +TODO: Outline how/when/why to fold in third party css using npm or yarn. \ No newline at end of file From fa2af7824653586a2a10e8dacbf0ccec852c78c1 Mon Sep 17 00:00:00 2001 From: Josh Schroeder Date: Wed, 11 Jan 2017 17:20:34 -0600 Subject: [PATCH 3/8] Add initial .gitignore --- .gitignore | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..05bc3fc --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.DS_STORE +*.log + +node_modules + +dist +coverage + +.idea/ From 64534d58740bd61b881d32286675a2c7c8ae034b Mon Sep 17 00:00:00 2001 From: Josh Schroeder Date: Wed, 11 Jan 2017 17:21:57 -0600 Subject: [PATCH 4/8] Initialize the package.json --- package.json | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 package.json diff --git a/package.json b/package.json new file mode 100644 index 0000000..0bb72f8 --- /dev/null +++ b/package.json @@ -0,0 +1,22 @@ +{ + "name": "caxy-front-end-starter-kit", + "version": "0.1.0", + "description": "Caxy's Front End Starter Kit", + "main": "index.js", + "directories": { + "test": "tests" + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/caxy/front-end-starter-kit.git" + }, + "author": "Caxy Code Creative (https://caxy.com)", + "license": "MIT", + "bugs": { + "url": "https://github.com/caxy/front-end-starter-kit/issues" + }, + "homepage": "https://github.com/caxy/front-end-starter-kit#readme" +} From 1208f6dbcf3fa5190ce750c8a5045e5485975292 Mon Sep 17 00:00:00 2001 From: Josh Schroeder Date: Wed, 11 Jan 2017 17:50:08 -0600 Subject: [PATCH 5/8] Add application structure documentation to README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b264ba9..8560749 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,28 @@ TODO: INSTALLATION AND SETUP ## Application Structure -TODO: DOCUMENT APPLICATION STRUCTURE +The application structure below is a starting point for the root project structure. This will be built upon as +standards are implemented for deeper directories. + +*DEV: When proposing standards that affect the application structure, please update this tree.* + + +``` +. +├── bin # Build/Start scripts +├── dist # The folder for the compiled output (ignored by git) +├── docs # 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 +│ ├── index.html # Main HTML page container for app +│ ├── main.js # Application bootstrap and rendering +│ └── styles # Application styles +│── tests # Unit tests +└── package.json # The list of 3rd party libraries and utilities +``` ## Development From 671604a75b7579cc92dd278e88f0adeb4015a778 Mon Sep 17 00:00:00 2001 From: Josh Schroeder Date: Wed, 11 Jan 2017 17:56:29 -0600 Subject: [PATCH 6/8] Add root project directories with README files --- bin/README.md | 1 + config/README.md | 1 + docs/README.md | 1 + public/README.md | 1 + public/favicon.ico | Bin 0 -> 5249 bytes public/humans.txt | 9 +++++++++ public/robots.txt | 2 ++ src/README.md | 1 + tests/README.md | 1 + 9 files changed, 17 insertions(+) create mode 100644 bin/README.md create mode 100644 config/README.md create mode 100644 docs/README.md create mode 100644 public/README.md create mode 100644 public/favicon.ico create mode 100644 public/humans.txt create mode 100644 public/robots.txt create mode 100644 src/README.md create mode 100644 tests/README.md diff --git a/bin/README.md b/bin/README.md new file mode 100644 index 0000000..efe0c21 --- /dev/null +++ b/bin/README.md @@ -0,0 +1 @@ +Build/Start scripts diff --git a/config/README.md b/config/README.md new file mode 100644 index 0000000..42c74ce --- /dev/null +++ b/config/README.md @@ -0,0 +1 @@ +Project and build configurations diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..c8f6449 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +Documentation files for the project diff --git a/public/README.md b/public/README.md new file mode 100644 index 0000000..7b269f6 --- /dev/null +++ b/public/README.md @@ -0,0 +1 @@ +Static public assets (not imported anywhere in the source code) diff --git a/public/favicon.ico b/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..eac17db8557644859170f511056143a668fa2875 GIT binary patch literal 5249 zcmW+)2UHVJ6Q@XsK#;B!F#!=mmEJ@NMG@&p303JN^kNhQ#85(yR0&9xUZsa7pg>TN zUX(7DQR?!CQzyED5p`@5OhnTs(pxCde2VW6U-g51~9G68zhc>{xhca>#z z4$xij*SP->3_Q=lPB>tE(MJdA5AaW)H);)$tf#;vcYwBKfT_1j0OqluGZhAdk#zS$ z`#V1NahCM`pb>JMzJ_{-ZiTs4c*N45z%V6YHuosm zKPR2RmUDCQ%16l1rG?7I>G~-ni`{G1ZojC#@jBpjIkWzQ-XOi#$5k0ZyY-7E_x?8hyO~Je zvPD={^|+NdxbPlZlYp+g_e!W8QGNqCUU89c-`zZ7A8yXcG;&Izx(!;b z>X+f95zAVkII1Oz&%Z~MtIr#-p%U3HAumD2o?;({s|%D^uq(A}II0*n^WWq83o64S zRII`uRQ5|VGA5a}^aimYyLjJfTo_DlOPfD-|DXe~TyZ6kB`$|oFps>O2;y_^=Y2~P zwbIVCkNNGJ`T%^%Dhaj*?EOMeZ+r3hA>Vp8wbd`nB*CGl*wp)QVpfyws{g9eR>l-o zNA^3^Ik|Sp>+61RkmoshEV=E!AJr0eq6=jpZ@i2W07KWww;(<=oYHO5lfIE{XRH=6mizWoJdhNoV~e7-wx+`kq$^+SjK zJ5&~*zT`zGe!I(Pb=s5wtk6*bkYG9N4bpa6@$T2*F8*;3=9RIdP+FJ4%ZhK1s@Vf<+j;@o>wYh1|jvvIN+# zW_}91ImZyh-oW(EA+5j;HP8jJwQC7gVy8Bdeb7c%o9(|K zDVPk{AVf0UymuXx2PaHyA+7UOT0p#dH%kza=TuV-gxAODt7YktK zhf!p10H6qtS(Ln;O?<*w?Xy+s!8w}e`8T7I?dCC4u3fxK)}=!O_Q+4`!zG88^#c;9 zOhel~V%r>Fr!nqqk3}l#TpU`e&TtK7y8GV z;D4uef)h5C!|3_#!5gnDg!Vwlo`v5=t^RuxeHbxSnal^Re4XsO*Dad8uJM7dCznU%#EfqZ0pBT=*h~WR?ujy6IR2LyQP5TSwcF}9RHy}y-gsiZ; z%{a!p z%R%$_b_-cy>1Q9*-n5xVN%Nk*f{ng~2j)-H=usJV%~vgqfd+idXyO4AQ5q*=HzD3K zQ*0qDA5bXVCHTyPG!%&dAwwlw(5Xwz@}r05WC6kW&I`}En!jAwJ!Tl4dO`LCQwR&Dm)Oq8(Brz9FXM9a<8;SsbqsD=+wfv#zX5)kW9_1@o5osIi4HKfeED8#>U2E+3AmH z&7r%Z2?V4BWgs3AWqH6JEr(uFehIO%N)uqAd2edoAsz=IW=iAMzte9tjLDXkTF|vx zq-rPtLLTGCDDSK=>o+!m$kb5#%e%`C3#W>kN5I?gr+3fo*ZYNSO zq9RS+QHUKhN;#Te8%qpaba(p0{pg|TIHH*AcbOvTw&bnx6$&vXxo+cA<;qL;~J*q5BVJ*>P-|<MBl7UzzG=Ii%#`x+LLl-k_gtw8xg z!9dWc!8$|xx4Ro9RzbdFTGQY|DPEfBV0EOdjEO709_+0yMa=p%)SU_5@m8b0-UuO< z$?BB8Ce!utaEBm_rJj6SrqKN{O+V>o!QQc$ijR26?eyaFPe#9#oPr}wIBORCf^n6n z7^>LcRm}{Vg`vuI``sFmi!`i6 z$caIy_$sF-9`N);z0{o8)4G6hP3HAucgK$r!_8uo?c-$*TY=c^%Mpr(s@A+BVy-Nw zYYRYR?Ao_sow3QIS> zKtThP;oFZ883lF)+=UC67l+O6)Xyxf>-pGRS=NAy``t|b0<|TO3(+;9f9q-hN;tD% zmn30d3~LNva=08S#^f1%mIx57e3e@VD4JCbC&tE7obfWPocns#iZK9=GPv=%qZtto zqt4SC2jYci5ww%vn%H6hi;71aBBw-rvWkmY_E#q5a6_}=G&&OwYSJM0w+o>Emez%b z0?v@eQf3V!N6de#o2t7`?gLRF{@f7frx+tz2`fF^HpZ*-9*<9lzO|0O0%NaS$6P$# zMw#>Y{x*7FAcwS|73zUf3wvqG6F)~^9@%OtuoFdUZ1gkR$>Te3zybAcf@1@}P%$H= z4li@QWh?A$1+T+sDPi4YXwlNT8G*28GYxzC1^G9*;ls@picb zVI`FDiVVK`=vzr6!T7w3#AuBU*;enN;YAUI{HoIvK>?dLbuQJg06Xa~HqoZB4n0nTG&;|US+0l&zxncN{e)tNs-)jfzc3+MuYDdu6*6NjnMwp^GHkBOW zn9XB4(irhQDNWvAUo7~Hy6%I9>UtE}5@OOHGiz+Pez=lG_vDvWi_;6vcWIq{C>HF4 zg}%pR!x|=~FEflZxz=v<(h5s`E_esOXRy@FI$oFa#CG z2OAlz$IkJ|3EgbliJVch`NUvT`L;3&?}0cad)WX07aT=NIgMzPExw zcF0d&Day6KuD=Zaq;s&T#N+2EtwXif`;VOI6B?8T?u(@_(<^WM;YLb0_ZhFsEJahF zg76+LXZ>N0RDs*JT;FK+F4eC#h~#n;5zHf@LV$nJOXUu?*}I{Fiu=nQDcxV`I^!E) zihfv*?Y-N_vlS7(Dv|p0opmFLhp0Rq$k=dQ9~B0jIxLPoFNj3ZK`xJ2gOfD=X1_X~ z)U5P~TYdbB=c53T(c`=x`b5Y{FRz!^H&hfsS^}c=$m~;Y3 z>#pX);H+;LiTlb~bb137Fi48Jcleo*Y?>UX*bv?h5OW`_yHDCj5Sj+Yfw!aCD@Vsq?@1mfGKm{@M zfBjgwUT25zK1{4v71pSN5aoG+6N=RmW2#v_Z4Cn(M(SzzNq0M%qR0d$hg5R!!tu7K zHaOzt@pqlhP`*9&#%t9BP;6y8!;UIO`Bu+N1%L|=d_ELiw1&S|?n$Z|fPx~GsIt;W z!+O-GO=*jG*1ZG|iccEsO^4_!6m;%<=Ai=uEjT~du86}GGb&&G>CH|##E-|{i{?xD z?v~l+S48JlYhAIhK%d)Fo|JD2EK5HT>ABV`zfi9okbgp2^m`2$40+&o<*?a=C0^Q9 zQ7`3+Pf*PON%cEGnmk`(0q_6%hP@k>Wd03rorZ|$;en2Q_~-n0C3-N-6gkc=9bGod z@EldRF3DH?V^jCGaT-D+rP-pc+puPA7$~eRzMg2Jj^LD>5>p@@Rql5#3u9Q{E5GK} z_^=$)<(Ve8WbT0vdKp}PV3WXyD%g<#u-9uC8;7)`uiG1IddY{4NF=unGw|wp{oeYB im2E3%sEZ<>(FZe1NiEu53j}@_Qr*`!(5lvW^zwf=#PgE? literal 0 HcmV?d00001 diff --git a/public/humans.txt b/public/humans.txt new file mode 100644 index 0000000..0bdb0f9 --- /dev/null +++ b/public/humans.txt @@ -0,0 +1,9 @@ +# Check it out: http://humanstxt.org/ + +# TEAM + + -- -- + +# THANKS + + diff --git a/public/robots.txt b/public/robots.txt new file mode 100644 index 0000000..eb05362 --- /dev/null +++ b/public/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..0aeca30 --- /dev/null +++ b/src/README.md @@ -0,0 +1 @@ +Application source code diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..76d5ef8 --- /dev/null +++ b/tests/README.md @@ -0,0 +1 @@ +Unit tests From 1b29de2b4a3fb40b4e367d89e91fe67f865310b1 Mon Sep 17 00:00:00 2001 From: Josh Schroeder Date: Thu, 12 Jan 2017 14:12:10 -0600 Subject: [PATCH 7/8] Add styles and styleguide directories --- README.md | 6 ++++-- src/styleguide/README.md | 1 + src/styleguide/pattern-markup/README.md | 1 + src/styles/README.md | 2 +- 4 files changed, 7 insertions(+), 3 deletions(-) create mode 100644 src/styleguide/README.md create mode 100644 src/styleguide/pattern-markup/README.md diff --git a/README.md b/README.md index 8560749..1b9242d 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,11 @@ standards are implemented for deeper directories. ├── 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 -│ └── styles # Application styles +│ └── main.js # Application bootstrap and rendering │── tests # Unit tests └── package.json # The list of 3rd party libraries and utilities ``` diff --git a/src/styleguide/README.md b/src/styleguide/README.md new file mode 100644 index 0000000..4f56a55 --- /dev/null +++ b/src/styleguide/README.md @@ -0,0 +1 @@ +Assets used in the styleguide that are not used in the application diff --git a/src/styleguide/pattern-markup/README.md b/src/styleguide/pattern-markup/README.md new file mode 100644 index 0000000..4260c51 --- /dev/null +++ b/src/styleguide/pattern-markup/README.md @@ -0,0 +1 @@ +HTML partials for the styleguide referenced via KSS diff --git a/src/styles/README.md b/src/styles/README.md index 9708d38..4135ffd 100644 --- a/src/styles/README.md +++ b/src/styles/README.md @@ -1,4 +1,4 @@ -# Project CSS +# Application styles ## Naming Conventions: BEM From 669de25e93778935b853e9b0266a62036601e7ef Mon Sep 17 00:00:00 2001 From: Josh Schroeder Date: Tue, 17 Jan 2017 17:01:34 -0600 Subject: [PATCH 8/8] Mark docs as optional --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b9242d..4c677de 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,10 @@ standards are implemented for deeper directories. . ├── bin # Build/Start scripts ├── dist # The folder for the compiled output (ignored by git) -├── docs # Documentation files for the project +├── docs # (optional) Supplemental documentation files for the project, if needed ├── 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) +├── server # (optional) Node server application that provides a http server for development │ └── main.js # Server application entry point ├── src # Application source code │ ├── styleguide # Assets used in the styleguide that are not used in the application