@haxtheweb/create 0.0.5 → 0.1.2

package/README.md

@@ -5,11 +5,32 @@ Rapidly build web components for the Web that work with HAX. HAX The Web's CLI t
 ## Future state
 - Create new HAX sites and administer them from the CLI
 - Create new themes for HAXcms
+- Interface w/ docs / AI agent on website
 
 # Usage
 
 ```bash
+npx @haxtheweb/create
+#or
 npm init @haxtheweb
 ```
 
-Follow the prompts and let's HAX the Web together!
+Follow the prompts and let's HAX the Web together!
+
+## Web component
+
+Step through answering basic install questions to build a HAX capable web component that works anywhere! Features:
+- LitElement based
+- DDDSuper class which adds our design system in
+- Common conventions used to demonstrate and work with property binding
+- Minor CSS variable inclusion for initial learning
+
+## HAX Site
+
+Build a HAX site that can be published and transported anywhere. Your users might love it on the front end, now you get the simplicity of building on the CLI.
+- Same HAX sites you can create via front end
+- Templated files that work just like any HAX site
+- End points baked in to do CLI commands for common endpoint operations like adding pages, deleting and editing.
+- Ability to import via URL just like the front-end
+- Theme development starting point to be able to build themes locally
+- Primed to publish to gh-pages, vercel and more

package/dist/{index.js → create.js}

@@ -17,24 +17,24 @@ async function main() {
   // should be able to grab author off the git config in most instances
   let value = await exec(`git config user.name`);
   let author = value.stdout.trim();
+  // delay so that we clear and then let them visually react to change
   await (0, _promises.setTimeout)(500);
-  p.intro(`${_picocolors.default.bgCyan(_picocolors.default.black(` HAX The CLI `))}`);
+  // intro text
+  p.intro(`${_picocolors.default.bgBlue(_picocolors.default.white(` HAXTheWeb CLI `))}`);
+  p.intro(`${_picocolors.default.bgMagenta(_picocolors.default.white(` Let's create a bright future `))}`);
   const project = await p.group({
     type: ({
       results
     }) => p.select({
       message: `What type of project are you building`,
       initialValue: 'webcomponent',
-      maxItems: 3,
+      maxItems: 2,
       options: [{
         value: 'webcomponent',
         label: 'Web component'
       }, {
-        value: 'haxcms',
+        value: 'haxsite',
         label: "HAX Site"
-      }, {
-        value: 'theme',
-        label: "HAX Theme"
       }]
     }),
     typeOption: ({
@@ -48,26 +48,15 @@ async function main() {
             maxItems: 1,
             options: [{
               value: 'hax',
-              label: "HAX recommended starter"
+              label: "HAX default"
             }]
           });
           break;
-        case "haxcms":
+        case "haxsite":
           return p.select({
             message: `What kind of site is it`,
-            initialValue: 'course',
-            maxItems: 2,
-            options: [{
-              value: 'course',
-              label: "Course"
-            }]
-          });
-          break;
-        case "theme":
-          return p.select({
-            message: `Theme base`,
-            initialValue: 'course',
-            maxItems: 2,
+            initialValue: 'default',
+            maxItems: 1,
             options: [{
               value: 'default',
               label: "Default"
@@ -80,14 +69,17 @@ async function main() {
       results
     }) => {
       return p.text({
-        message: 'Element name:',
-        initialValue: "my-element",
+        message: 'Project name:',
+        placeholder: results.type === "webcomponent" ? "my-element" : "mysite",
         validate: value => {
+          if (!value) {
+            return "Name is required";
+          }
           if (value.indexOf(' ') !== -1) {
             return "No spaces allowed in project name";
           }
-          if (value.indexOf('-') === -1) {
-            return "Name must include at least one `-`";
+          if (results.type === "webcomponent" && value.indexOf('-') === -1 && value.indexOf('-') !== 0 && value.indexOf('-') !== value.length - 1) {
+            return "Name must include at least one `-` and must not start or end name.";
           }
         }
       });
@@ -108,7 +100,15 @@ async function main() {
         message: 'Author:',
         initialValue: author
       });
-    }
+    },
+    install: () => p.confirm({
+      message: 'Install dependencies? (npm)',
+      initialValue: true
+    }),
+    git: () => p.confirm({
+      message: 'Put in version control? (git)',
+      initialValue: true
+    })
   }, {
     onCancel: () => {
       p.cancel('Operation cancelled.');
@@ -116,36 +116,56 @@ async function main() {
     }
   });
   if (project.path) {
+    // values not set but important for templating
     project.className = dashToCamel(project.name);
+    project.version = "9.0.0-alpha.0";
+    project.id = generateUUID();
+    project.timestamp = Date.now();
+    project.hexCode = "#009dc7";
+    // icons
+    ["48x48", "72x72", "96x96", "144x144", "192x192", "256x256", "512x512"].map(size => project[`logo${size}`] = `assets/icon-${size}`);
+    console.log(project);
     let s = p.spinner();
     s.start('Copying files');
     await (0, _promises.setTimeout)(250);
-    await exec(`cp -R ${path.resolve(path.dirname(''))}/src/templates/${project.type}/${project.typeOption}/ ${project.path}`);
+    await exec(`cp -R ${process.mainModule.path}/templates/${project.type}/${project.typeOption}/ ${project.path}`);
     // rename paths that are of the element name in question
     await exec(`mv ${project.path}/src/webcomponent.js ${project.path}/src/${project.name}.js`);
     await exec(`mv ${project.path}/lib/webcomponent.haxProperties.json ${project.path}/lib/${project.name}.haxProperties.json`);
     s.stop('Files copied');
     await (0, _promises.setTimeout)(250);
     s.start('Making files awesome');
-    try {
-      for (const filePath of readAllFiles(project.path)) {
-        const ejsString = ejs.fileLoader(filePath, 'utf8');
-        let content = ejs.render(ejsString, project);
-        fs.writeFileSync(filePath, content);
+    for (const filePath of readAllFiles(project.path)) {
+      try {
+        if (!filePath.endsWith('.jpg') && !filePath.endsWith('.png')) {
+          const ejsString = ejs.fileLoader(filePath, 'utf8');
+          let content = ejs.render(ejsString, project);
+          fs.writeFileSync(filePath, content);
+          // file written successfully  
+        }
+      } catch (err) {
+        console.error(filePath);
+        console.error(err);
       }
-      // file written successfully
-    } catch (err) {
-      console.error(err);
     }
     s.stop('Files are now awesome!');
-    await (0, _promises.setTimeout)(250);
-    s.start(`Let's install everything using the magic of yarn`);
-    await (0, _promises.setTimeout)(250);
-    await exec(`cd ${project.path} && yarn install`);
-    await (0, _promises.setTimeout)(250);
-    s.stop(`Everything is installed. It's go time`);
+    if (project.install) {
+      await (0, _promises.setTimeout)(250);
+      s.start(`Let's install everything using the magic of npm`);
+      await (0, _promises.setTimeout)(250);
+      await exec(`cd ${project.path} && npm install`);
+      await (0, _promises.setTimeout)(250);
+      s.stop(`Everything is installed. It's go time`);
+    }
+    if (project.git) {
+      project.gitRepo = await p.text({
+        message: 'Git Repo location:',
+        placeholder: `git@github.com:${project.author}/${project.name}.git`
+      });
+      await exec(`cd ${project.path} && git init && git add -A && git commit -m "first commit" && git branch -M main${project.gitRepo != '' ? ` && git remote add origin ${project.gitRepo}` : ''}`);
+    }
   }
-  let nextSteps = `cd ${project.path}     \nyarn start`;
+  let nextSteps = `cd ${project.path}     \n${project.install ? '' : 'npm install\n'} npm start`;
   p.note(nextSteps, `${project.name} is ready to go. To start development:`);
   p.outro(`Welcome to the revolution. Ideas to HAX faster? ${_picocolors.default.underline(_picocolors.default.cyan('https://github.com/haxtheweb/issues'))}`);
 }
@@ -171,4 +191,10 @@ function* readAllFiles(dir) {
       yield path.join(dir, file.name);
     }
   }
+}
+function generateUUID() {
+  return "ss-s-s-s-sss".replace(/s/g, _uuidPart);
+}
+function _uuidPart() {
+  return Math.floor((1 + Math.random()) * 0x10000).toString(16).substring(1);
 }

package/dist/templates/haxsite/default/.htaccess

@@ -0,0 +1,79 @@
+# Protect files and directories from prying eyes.
+<FilesMatch "\.(make|test|po|sh|.*sql|theme|tpl(\.php)?|xtmpl)(~|\.sw[op]|\.bak|\.orig|\.save)?$|^(\.(?!well-known).*|Entries.*|Repository|Root|Tag|Template|composer\.(json|lock))$|^#.*#$|\.php(~|\.sw[op]|\.bak|\.orig\.save)$">
+  <IfModule mod_authz_core.c>
+    Require all denied
+  </IfModule>
+  <IfModule !mod_authz_core.c>
+    Order allow,deny
+  </IfModule>
+</FilesMatch>
+# Don't show directory listings for URLs which map to a directory.
+Options -Indexes
+# Follow symbolic links in this directory.
+Options +FollowSymLinks
+# Set the default handler.
+DirectoryIndex index.php index.html
+# Override PHP settings that cannot be changed at runtime. See
+<IfModule mod_php5.c>
+  php_flag magic_quotes_gpc                 off
+  php_flag magic_quotes_sybase              off
+  php_flag register_globals                 off
+  php_flag session.auto_start               off
+  php_value mbstring.http_input             pass
+  php_value mbstring.http_output            pass
+  php_flag mbstring.encoding_translation    off
+</IfModule>
+# Requires mod_expires to be enabled.
+<IfModule mod_expires.c>
+  # Enable expirations.
+  ExpiresActive On
+  # Cache all files for 2 weeks after access (A).
+  ExpiresDefault A1209600
+  <FilesMatch \.php$>
+    ExpiresActive Off
+  </FilesMatch>
+</IfModule>
+# Various rewrite rules.
+<IfModule mod_rewrite.c>
+  RewriteEngine on
+  # Set "protossl" to "s" if we were accessed via https://.  This is used later
+  # if you enable "www." stripping or enforcement, in order to ensure that
+  # you don't bounce between http and https.
+  RewriteRule ^ - [E=protossl]
+  RewriteCond %{HTTPS} on
+  RewriteRule ^ - [E=protossl:s]
+  # Make sure Authorization HTTP header is available to PHP
+  # even when running as CGI or FastCGI.
+  RewriteRule ^ - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
+  # Pass all requests not referring directly to files in the filesystem to
+  RewriteCond %{REQUEST_FILENAME} !-f
+  RewriteCond %{REQUEST_FILENAME} !-d
+  RewriteRule ^ . [L]
+
+  # Rules to correctly serve gzip compressed CSS and JS files.
+  # Requires both mod_rewrite and mod_headers to be enabled.
+  <IfModule mod_headers.c>
+    # Serve gzip compressed CSS files if they exist and the client accepts gzip.
+    RewriteCond %{HTTP:Accept-encoding} gzip
+    RewriteCond %{REQUEST_FILENAME}\.gz -s
+    RewriteRule ^(.*)\.css $1\.css\.gz [QSA]
+    # Serve gzip compressed JS files if they exist and the client accepts gzip.
+    RewriteCond %{HTTP:Accept-encoding} gzip
+    RewriteCond %{REQUEST_FILENAME}\.gz -s
+    RewriteRule ^(.*)\.js $1\.js\.gz [QSA]
+    # Serve correct content types, and prevent mod_deflate double gzip.
+    RewriteRule \.css\.gz$ - [T=text/css,E=no-gzip:1]
+    RewriteRule \.js\.gz$ - [T=text/javascript,E=no-gzip:1]
+    <FilesMatch "(\.js\.gz|\.css\.gz)$">
+      # Serve correct encoding type.
+      Header set Content-Encoding gzip
+      # Force proxies to cache gzipped & non-gzipped css/js files separately.
+      Header append Vary Accept-Encoding
+    </FilesMatch>
+  </IfModule>
+</IfModule>
+# Add headers to all responses.
+<IfModule mod_headers.c>
+  # Disable content sniffing, since it's an attack vector.
+  Header always set X-Content-Type-Options nosniff
+</IfModule>

package/dist/templates/haxsite/default/404.html

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Single Page Apps for GitHub Pages</title>
+    <script type="text/javascript">
+      // Single Page Apps for GitHub Pages
+      // https://github.com/rafrex/spa-github-pages
+      // Copyright (c) 2016 Rafael Pedicini, licensed under the MIT License
+      // ----------------------------------------------------------------------
+      // This script takes the current url and converts the path and query
+      // string into just a query string, and then redirects the browser
+      // to the new url with only a query string and hash fragment,
+      // e.g. http://www.foo.tld/one/two?a=b&c=d#qwe, becomes
+      // http://www.foo.tld/?p=/one/two&q=a=b~and~c=d#qwe
+      // Note: this 404.html file must be at least 512 bytes for it to work
+      // with Internet Explorer (it is currently > 512 bytes)
+
+      // If you're creating a Project Pages site and NOT using a custom domain,
+      // then set segmentCount to 1 (enterprise users may need to set it to > 1).
+      // This way the code will only replace the route part of the path, and not
+      // the real directory in which the app resides, for example:
+      // https://username.github.io/repo-name/one/two?a=b&c=d#qwe becomes
+      // https://username.github.io/repo-name/?p=/one/two&q=a=b~and~c=d#qwe
+      // Otherwise, leave segmentCount as 0.
+      var segmentCount = 0;
+      if (window.location.host.indexOf('github.io') != -1 && window.location.pathname.split('/').length > 1) {
+        segmentCount = 1;
+      }
+      var l = window.location;
+      l.replace(
+        l.protocol + '//' + l.hostname + (l.port ? ':' + l.port : '') +
+        l.pathname.split('/').slice(0, 1 + segmentCount).join('/') + '/?p=/' +
+        l.pathname.slice(1).split('/').slice(segmentCount).join('/').replace(/&/g, '~and~') +
+        (l.search ? '&q=' + l.search.slice(1).replace(/&/g, '~and~') : '') +
+        l.hash
+      );
+
+    </script>
+  </head>
+  <body>
+  </body>
+</html>

package/dist/templates/haxsite/default/Dockerfile

@@ -0,0 +1,15 @@
+FROM haxtheweb/haxcms:2.0.9 as haxcms
+
+FROM php:7.3-apache
+
+RUN a2enmod rewrite
+COPY ./services/haxcms/apache2.conf /etc/apache2/apache2.conf
+
+COPY . /var/www/html
+COPY --from=haxcms /var/www/html/build /var/www/html/build
+COPY --from=haxcms /var/www/html/dist /var/www/html/dist
+COPY --from=haxcms /var/www/html/system /var/www/html/system
+COPY --from=haxcms /var/www/html/assets/babel-top.js /var/www/html/assets/babel-top.js
+COPY --from=haxcms /var/www/html/assets/babel-bottom.js /var/www/html/assets/babel-bottom.js
+COPY --from=haxcms /var/www/html/wc-registry.json /var/www/html/wc-registry.json
+RUN chown -R www-data:www-data /var/www/html

package/dist/templates/haxsite/default/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 The Pennsylvania State University
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/templates/haxsite/default/README.md

@@ -0,0 +1,38 @@
+# HAXsite
+This is a HAXcms generated and managed micro-site. It can run on it's own but it was generated by a HAXcms system somewhere.
+
+## Developer mode
+HAXcms primary audience is people doing things entirely through the UI. It is however creating everything in a way that's very developer friendly though. This means you can peal this off from the original place it came from and run this as a stand alone repo by:
+
+- leveraging the included package.json
+- removing the symlinks to dist / node_modules / build
+- copying the dist directory from the project root into your local setup: https://github.com/haxtheweb/haxcms/tree/master/dist
+
+Using this approach you'll have to manage dependencies on your own but you'll be able to utilize custom themes / elements that you can to show up. If you do add any new elements or themes you'll need to ship this repo with the `polymer build` command executed in order to bundle / compile everything together for usage.
+
+### special note
+The CDN mirrors for HAXcms may or may not include the elements you wish to extend your project with so those options for rapid distributed publishing may not be availble.
+
+# HAXcms
+HAX CMS seeks to be the smallest possible back-end CMS to make HAX work and be able to build websites with it. Leveraging JSON Outline Schema, HAX is able to author multiple pages, which it then writes onto the file system.
+
+# Customization capabilities as a developer
+
+## Want to customize the theme via global CSS
+- make changes to `theme/theme.css`
+- This CSS loads on initial system load and CSS variables / ::part selectors can help override values
+
+## Want to customize the JS that's run globally?
+- make changes to `custom/build/custom.es6.js`
+- This can also be modified as part of a built in build routine layed out in `custom/build`
+- Assets can be built using the yarn / rollup routine that's included or manually writing JS into the files
+
+Global JS could be used to load tracking code or inject your own custom element definitions so you can add your own web components in.
+
+This can also be used to make a custom theme (modifying details in site.json to point to your theme element can make it load then)
+
+## Need to customize something else?
+https://github.com/elmsln/issues/issues or join the community on discord https://bit.ly/hax-discord and ask! 
+
+## License
+[Apache 2.0](LICENSE.md)