@evershop/evershop 1.0.0-beta

package/README.md

@@ -0,0 +1,132 @@
+<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</p>
+<p align="center">
+  <h1 align="center">Lightweight, modular, extendable React ecommerce platform.</h1>
+</p>
+<p align="center">
+    <a href="https://evershop.io/docs/development/getting-started/introduction">Documentation</a>
+</p>
+<p align="center">
+  <img src="https://github.com/nodeonline/nodejscart/actions/workflows/build.yml/badge.svg" alt="Github Action">
+  <a href="https://discord.gg/GSzt7dt7RM">
+    <img src="https://img.shields.io/discord/757179260417867879?label=discord" alt="Discord">
+  </a>
+  <a href="https://opensource.org/licenses/GPL-3.0">
+    <img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License">
+  </a>
+</p>
+
+## Component-Level Data Fetching (Server Side Props)
+
+```javascript
+import React from 'react';
+import Products from './components/Products';
+
+export default function NewArrival({ products }) {
+    return <div>
+      <h2>New Arrival</h2>
+      <Products products={products}/>
+    </div>
+}
+
+// The GraphQL query result will be passed to the page component as props
+export const query = `
+  query NewArrival {
+    products {
+      name
+      price
+      image {
+        alt
+        url
+      }
+      url
+    }
+}
+`
+```
+
+## Demo
+
+Explore our demo store.
+
+<p align="center">
+<!--img alt="EverShop Admin Demo" width="950" src="https://raw.githubusercontent.com/evershopcommerce/evershop/dev/.github/images/evershop-backend-demo.png"/>
+</p-->
+<p align="left">
+  <a href="https://demo.evershop.io/" target="_blank">
+    <img alt="evershop-store-demo" height="35" alt="EverShop Store Demo" src="https://raw.githubusercontent.com/evershopcommerce/evershop/dev/.github/images/evershop-store-front-demo.png"/>
+  </a>
+</p>
+
+<p align="left">
+  <a href="https://demo.evershop.io/admin" target="_blank">
+    <img alt="evershop-backend-demo" height="35" alt="EverShop Admin Demo" src="https://raw.githubusercontent.com/evershopcommerce/evershop/dev/.github/images/evershop-admin-demo.png"/>
+  </a>
+</p>
+<b>Demo user:</b>
+
+Email: demo@gmail.com<br/>
+Password: 123456
+<!--p align="center">
+<img alt="EverShop Store Demo" width="950" src="https://raw.githubusercontent.com/evershopcommerce/evershop/dev/.github/images/evershop-product-detail.png"/>
+</p-->
+
+
+## Quick Start
+
+You can get started with EverShop in minutes by running the following command:
+
+```bash
+npx create-evershop-app my-app --playAround
+```
+
+- [Installation guide](https://evershop.io/docs/development/getting-started/installation-guide).
+
+- [Extension development](https://evershop.io/docs/development/module/create-your-first-extension).
+
+- [Theme development](https://evershop.io/docs/development/theme/theme-overview).
+
+## Features
+- Catalog management(with product attribute, custom option and variants)
+- Order management
+- Customer management
+- Coupon management
+- Tax
+- Online payment (For now using Stripe)
+- Basic CMS pages management
+- Easy to customize by developing extensions
+
+## Support
+
+If you like my work, feel free to:
+
+- ⭐ this repository. It is a big motivation for me to continue working on this project.
+- [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)][tweet] about EverShop
+
+[tweet]: https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fevershopcommerce%2Fevershop&text=Awesome%20React%20Ecommerce%20Project&hashtags=react,ecommerce,expressjs,graphql
+### Ask a question about EverShop
+
+You can ask questions, and participate in discussions about EverShop-related topics in the EverShop Discord channel.
+
+<a href="https://discord.gg/GSzt7dt7RM"><img src="https://raw.githubusercontent.com/evershopcommerce/evershop/dev/.github/images/discord_banner_github.svg" /></a>
+
+### Create a bug report
+
+If you see an error message or run into an issue, please [create bug report](https://github.com/evershopcommerce/evershop/issues/new). This effort is valued and it will help all EverShop users.
+
+
+### Submit a feature request
+
+If you have an idea, or you're missing a capability that would make development easier and more robust, please [Submit feature request](https://github.com/evershopcommerce/evershop/issues/new).
+
+If a similar feature request already exists, don't forget to leave a "+1".
+If you add some more information such as your thoughts and vision about the feature, your comments will be embraced warmly :)
+
+## Contributing
+
+EverShop is an open-source project. We are committed to a fully transparent development process and appreciate highly any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as part of the EverShop community.
+
+Please refer to our [Contribution Guidelines](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## License
+
+[GPL-3.0 License](https://github.com/evershopcommerce/evershop/blob/main/LICENSE)

package/bin/build/client/index.js

@@ -0,0 +1,22 @@
+const webpack = require('webpack');
+const { createConfigClient } = require('../../../src/lib/webpack/prod/createConfigClient');
+
+module.exports.buildClient = async function buildClient(routes) {
+  const config = createConfigClient(routes);
+  console.log('client', config);
+  const compiler = webpack(config);
+
+  return new Promise((resolve, reject) => {
+    compiler.run((err, stats) => {
+      if (err || stats.hasErrors()) {
+        console.log(stats.toString({
+          errorDetails: true,
+          warnings: true
+        }));
+        reject(err);
+      }
+      resolve(stats);
+    });
+  }
+  );
+};

package/bin/build/complie.js

@@ -0,0 +1,24 @@
+const { webpack } = require('webpack');
+const { createConfigClient } = require('../../src/lib/webpack/prod/createConfigClient');
+const { createConfigServer } = require('../../src/lib/webpack/prod/createConfigServer');
+
+module.exports.compile = async function compile(routes) {
+  const config = [createConfigClient(routes), createConfigServer(routes)];
+
+  const compiler = webpack(config);
+
+  return new Promise((resolve, reject) => {
+    compiler.run((err, stats) => {
+      if (err || stats.hasErrors()) {
+        console.log(err);
+        console.log(stats.toString({
+          errorDetails: true,
+          warnings: true
+        }));
+        reject(err);
+      }
+      resolve(stats);
+    });
+  }
+  );
+}

package/bin/build/index.js

@@ -0,0 +1,54 @@
+const { existsSync, rmSync, mkdirSync } = require('fs');
+const path = require('path');
+const { Componee } = require('../../src/lib/componee/Componee');
+const { CONSTANTS } = require('../../src/lib/helpers');
+const { getRoutes } = require('../../src/lib/router/Router');
+const { isBuildRequired } = require('../../src/lib/webpack/isBuildRequired');
+const { getEnabledExtensions } = require('../extension');
+const { buildEntry } = require('../lib/buildEntry');
+const { buildTailwind } = require('../lib/buildTailWind');
+const { loadModuleRoutes } = require('../lib/loadModuleRoutes');
+const { getCoreModules } = require('../lib/loadModules');
+const { compile } = require('./complie');
+
+/* Loading modules and initilize routes, components */
+const modules = [...getCoreModules(), ...getEnabledExtensions()];
+
+/** Loading routes  */
+modules.forEach((module) => {
+  try {
+    // Load routes
+    loadModuleRoutes(module.path);
+  } catch (e) {
+    console.log(e);
+    process.exit(0);
+  }
+});
+
+/** Loading components */
+modules.forEach((module) => {
+  try {
+    // Load components
+    Componee.loadModuleComponents(module);
+  } catch (e) {
+    console.log(e);
+    process.exit(0);
+  }
+});
+
+/** Clean up the build directory */
+if (existsSync(path.resolve(CONSTANTS.BUILDPATH))) {
+  // Delete directory recursively
+  rmSync(path.resolve(CONSTANTS.BUILDPATH), { recursive: true });
+  mkdirSync(path.resolve(CONSTANTS.BUILDPATH));
+} else {
+  mkdirSync(path.resolve(CONSTANTS.BUILDPATH), { recursive: true });
+}
+
+(async () => {
+  const routes = getRoutes();
+  await buildEntry(routes.filter((r) => isBuildRequired(r)));
+
+  /** Build  */
+  await compile(routes);
+})();

package/bin/build/server/index.js

@@ -0,0 +1,21 @@
+const webpack = require('webpack');
+const { createConfigServer } = require('../../../src/lib/webpack/prod/createConfigServer');
+
+module.exports.buildServer = async function buildServer(routes) {
+  const config = createConfigServer(routes);
+  const compiler = webpack(config);
+
+  return new Promise((resolve, reject) => {
+    compiler.run((err, stats) => {
+      if (err || stats.hasErrors()) {
+        console.log(stats.toString({
+          errorDetails: true,
+          warnings: true
+        }));
+        reject(err);
+      }
+      resolve(stats);
+    });
+  }
+  );
+};

package/bin/build/server/useDDL.js

@@ -0,0 +1,206 @@
+const path = require('path');
+const {
+  existsSync, rmdirSync
+} = require('fs');
+const { writeFile, mkdir } = require('fs').promises;
+const { inspect } = require('util');
+const { CONSTANTS } = require('../../../src/lib/helpers');
+const { loadModules } = require('../../serve/loadModules');
+const ora = require('ora');
+const { red, green } = require('kleur');
+const boxen = require('boxen');
+const { loadModuleRoutes } = require('../../serve/loadModuleRoutes');
+const { loadModuleComponents } = require('../../serve/loadModuleComponents');
+const { getRoutes } = require('../../../src/lib/router/routes');
+const { getComponentsByRoute } = require('../../../src/lib/componee/getComponentByRoute');
+const webpack = require('webpack');
+
+const modules = loadModules(path.resolve(__dirname, '../../../src', 'modules'));
+
+const spinner = ora({
+  text: green('Starting server build'),
+  spinner: 'dots12'
+}).start();
+spinner.start();
+
+
+// Initilizing routes
+modules.forEach((module) => {
+  try {
+    // Load routes
+    loadModuleRoutes(module.path);
+  } catch (e) {
+    spinner.fail(`${red(e.stack)}\n`);
+    process.exit(0);
+  }
+});
+
+// Initializing components
+modules.forEach((module) => {
+  try {
+    // Load components
+    loadModuleComponents(module.path);
+  } catch (e) {
+    spinner.fail(`${red(e.stack)}\n`);
+    process.exit(0);
+  }
+});
+
+const routes = getRoutes();
+
+// Collect all "controller" route
+const controllers = routes.filter((r) => (r.isApi === false));
+
+const promises = [];
+const total = controllers.length - 1;
+let completed = 0;
+
+spinner.text = `Start building ☕☕☕☕☕\n${Array(total).fill('▒').join('')}`;
+
+if (existsSync(path.resolve(CONSTANTS.ROOTPATH, './.evershop/build'))) {
+  rmdirSync(path.resolve(CONSTANTS.ROOTPATH, './.evershop/build'), { recursive: true });
+}
+const start = Date.now();
+
+
+// Run building vendor first
+const { createVendorConfig } = require('../../../src/lib/webpack/configProvider');
+const vendorComplier = webpack(createVendorConfig(webpack));
+const webpackVendorPromise = new Promise((resolve, reject) => {
+  vendorComplier.run((err, stats) => {
+    if (err) {
+      reject(err);
+    } else if (stats.hasErrors()) {
+      reject(new Error(stats.toString({
+        errorDetails: true,
+        warnings: true
+      })));
+    } else {
+      resolve(stats);
+    }
+  });
+});
+
+webpackVendorPromise.then(async () => {
+  controllers.forEach((route) => {
+    const buildFunc = async function () {
+      const components = getComponentsByRoute(route.id);
+
+      if (!components) { return; }
+      Object.keys(components).forEach((area) => {
+        Object.keys(components[area]).forEach((id) => {
+          components[area][id].component = `---require("${components[area][id].source}")---`;
+          delete components[area][id].source;
+        });
+      });
+
+      const buildPath = route.isAdmin === true ? `./admin/${route.id}` : `./frontStore/${route.id}`;
+      let content = `var components = module.exports = exports = ${inspect(components, { depth: 5 }).replace(/'---/g, '').replace(/---'/g, '')}`;
+      content += '\r\n';
+      await mkdir(path.resolve(CONSTANTS.ROOTPATH, './.evershop/build', buildPath), { recursive: true });
+      await writeFile(path.resolve(CONSTANTS.ROOTPATH, '.evershop/build', buildPath, 'components.js'), content);
+      const name = route.isAdmin === true ? `admin/${route.id}` : `frontStore/${route.id}`;
+      const entry = {};
+      entry[name] = [
+        path.resolve(CONSTANTS.ROOTPATH, '.evershop', 'build', buildPath, 'components.js'),
+        path.resolve(CONSTANTS.LIBPATH, 'components', 'render.js')
+      ];
+      const compiler = webpack({
+        mode: 'production', // "production" | "development" | "none"
+        module: {
+          rules: [
+            {
+              test: /\/views|components|context\/(.*).js?$/,
+              //test: /\.js?$/,
+              exclude: /(bower_components)/,
+              use: {
+                loader: 'babel-loader?cacheDirectory',
+                options: {
+                  sourceType: 'unambiguous',
+                  cacheDirectory: true,
+                  presets: [
+                    [
+                      "@babel/preset-env",
+                      {
+                        "exclude": ["@babel/plugin-transform-regenerator", "@babel/plugin-transform-async-to-generator"]
+                      }
+                    ],
+                    '@babel/preset-react'
+                  ]
+                }
+              }
+            },
+            {
+              test: /getComponents\.js/,
+              use: [
+                {
+                  loader: path.resolve(CONSTANTS.LIBPATH, 'webpack/getComponentLoader.js'),
+                  options: {
+                    componentsPath: path.resolve(CONSTANTS.ROOTPATH, './.evershop/build', buildPath, 'components.js')
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        // name: 'main',
+        target: 'node12.18',
+        entry,
+        output: {
+          path: path.resolve(CONSTANTS.ROOTPATH, './.evershop/build', buildPath, 'server'),
+          libraryTarget: "commonjs2",
+          globalObject: "this",
+          filename: 'index.js'
+        },
+        resolve: {
+          alias: {
+            react: path.resolve(CONSTANTS.NODEMODULEPATH, 'react')
+          }
+        },
+        plugins: [
+          new webpack.DllReferencePlugin({
+            manifest: path.resolve(CONSTANTS.ROOTPATH, './.evershop/build/vendor-manifest.json')
+          })
+        ]
+      });
+
+      const webpackPromise = new Promise((resolve, reject) => {
+        compiler.run((err, stats) => {
+          if (err) {
+            reject(err);
+          } else if (stats.hasErrors()) {
+            reject(new Error(stats.toString({
+              errorDetails: true,
+              warnings: true
+            })));
+          } else {
+            resolve(stats);
+          }
+        });
+      });
+
+      await webpackPromise;
+      completed += 1;
+      spinner.text = `Start building ☕☕☕☕☕\n${Array(completed).fill(green('█')).concat(total - completed > 0 ? Array(total - completed).fill('▒') : []).join('')}`;
+    };
+    promises.push(buildFunc());
+  });
+
+  await Promise.all(promises)
+    .then(() => {
+      spinner.succeed(green('Building completed!!!\n') + boxen(green('Please run "npm run start" to start your website'), {
+        title: 'EverShop', titleAlignment: 'center', padding: 1, margin: 1, borderColor: 'green'
+      }));
+      const end = Date.now();
+      console.log(`Execution time: ${end - start} ms`);
+
+      process.exit(0);
+    })
+    .catch((e) => {
+      spinner.fail(`${red(e)}\n`);
+      process.exit(0);
+    });
+});
+
+
+

package/bin/build/server/useVendorChunk.js

@@ -0,0 +1,84 @@
+const path = require('path');
+const {
+  existsSync, rmSync
+} = require('fs');
+const { CONSTANTS } = require('../../../src/lib/helpers');
+const { loadModules } = require('../../serve/loadModules');
+const ora = require('ora');
+const { red, green } = require('kleur');
+const boxen = require('boxen');
+const { loadModuleRoutes } = require('../../serve/loadModuleRoutes');
+const { loadModuleComponents } = require('../../serve/loadModuleComponents');
+const { getRoutes } = require('../../../src/lib/router/routes');
+const webpack = require('webpack');
+const { createConfig } = require('../../../src/lib/webpack/createConfig');
+const { createComponents } = require('../createComponents');
+
+(async () => {
+  const start = Date.now();
+  const modules = loadModules(path.resolve(__dirname, '../../../src', 'modules'));
+  const spinner = ora({
+    text: green('Starting server build'),
+    spinner: 'dots12'
+  }).start();
+  spinner.start();
+
+  /** Initilizing routes */
+  modules.forEach((module) => {
+    try {
+      // Load routes
+      loadModuleRoutes(module.path);
+    } catch (e) {
+      spinner.fail(`${red(e.stack)}\n`);
+      process.exit(0);
+    }
+  });
+
+  /** Initializing components */
+  modules.forEach((module) => {
+    try {
+      // Load components
+      loadModuleComponents(module.path);
+    } catch (e) {
+      spinner.fail(`${red(e.stack)}\n`);
+      process.exit(0);
+    }
+  });
+
+  /** Get list of routes */
+  const routes = getRoutes();
+
+  /** Collect all 'controller' routes */
+  const controllers = routes.filter((r) => (r.isApi === false));
+
+  /** Clean up the build directory */
+  if (existsSync(CONSTANTS.BUILDPATH)) {
+    rmSync(CONSTANTS.BUILDPATH, { recursive: true });
+  }
+
+  /** Create components.js file for each route */
+  await createComponents(controllers);
+
+  /** Create the webpack complier object */
+  const compiler = webpack(createConfig(true, controllers));
+
+  /** Run the build */
+  await new Promise((resolve, reject) => {
+    compiler.run((err, stats) => {
+      if (err) {
+        reject(err);
+      } else if (stats.hasErrors()) {
+        reject(new Error(stats.toString({
+          errorDetails: true,
+          warnings: true
+        })));
+      } else {
+        resolve(stats);
+      }
+    });
+  });
+
+  const end = Date.now();
+  spinner.succeed(`${green('Server build completed in')} ${end - start}ms`);
+  process.exit(0);
+})();

package/bin/dev/index.js

@@ -0,0 +1,15 @@
+const { start } = require('../lib/startUp');
+const { watch } = require('../lib/watch/watch');
+const { watchMF } = require('../lib/watch/watchMF');
+const { watchPage } = require('../lib/watch/watchPage');
+const { watchSchema } = require('../lib/watch/watchSchema');
+
+(async () => {
+  await start(() => {
+    watch([
+      watchPage,
+      watchSchema,
+      watchMF
+    ]);
+  });
+})();

package/bin/evershop

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+/* eslint-disable global-require */
+const yargs = require('yargs/yargs');
+const { hideBin } = require('yargs/helpers');
+
+const { argv } = yargs(hideBin(process.argv));
+const command = argv._[0];
+process.on('uncaughtException', function (exception) {
+  console.log(exception); // to see your exception details in the console
+  // if you are on production, maybe you can send the exception details to your
+  // email as well ?
+});
+process.on('unhandledRejection', (reason, p) => {
+  console.log("Unhandled Rejection at: Promise ", p, " reason: ", reason);
+  // application specific logging, throwing an error, or other logic here
+});
+
+try {
+  if (command === 'build') {
+    process.env.NODE_ENV = 'production';
+    require('./build/index');
+  } else if (command === 'dev') {
+    process.env.NODE_ENV = 'development';
+    require('./dev');
+  } else if (command === 'start') {
+    process.env.NODE_ENV = 'production';
+    require('./start');
+  } else if (command === 'install') {
+    require('./install');
+  } else {
+    throw new Error('Invalid command');
+  }
+} catch (e) {
+  console.log(e);
+}

package/bin/extension/index.js

@@ -0,0 +1,34 @@
+const { existsSync } = require('fs');
+const { resolve } = require('path');
+const { CONSTANTS } = require('../../src/lib/helpers');
+const { getConfig } = require('../../src/lib/util/getConfig');
+const { getCoreModules } = require('../lib/loadModules');
+
+var extensions = [];
+
+function loadExtensions() {
+  const coreModules = getCoreModules()
+  const list = getConfig('system.extensions', []);
+  const extensions = [];
+  list.forEach((extension) => {
+    if (coreModules.find((module) => module.name === extension.name) ||
+      extensions.find((e) => e.name === extension.name)
+    ) {
+      throw new Error(`Extension ${extension.name} is invalid. extension name must be unique.`);
+    }
+    if (extension.enabled === true && existsSync(resolve(CONSTANTS.ROOTPATH, extension.resolve))) {
+      extensions.push({ ...extension, path: resolve(CONSTANTS.ROOTPATH, extension.resolve) });
+    } else {
+      console.log(`Extension ${extension.name} is either disabled or the path is not existed.`);
+    }
+  });
+
+  return extensions;
+}
+
+module.exports.getEnabledExtensions = function getEnabledExtensions() {
+  if (extensions.length === 0) {
+    extensions = loadExtensions();
+  }
+  return extensions;
+}

package/bin/install/createMigrationTable.js

@@ -0,0 +1,15 @@
+const { execute } = require("@evershop/mysql-query-builder");
+
+module.exports.createMigrationTable = async function createMigrationTable(connection) {
+  await execute(connection, `CREATE TABLE \`migration\` (
+        \`migration_id\` int(10) unsigned NOT NULL AUTO_INCREMENT,
+        \`module\` char(255) NOT NULL,
+        \`version\` char(255) NOT NULL,
+        \`status\` char(255) NOT NULL,
+        \`created_at\` timestamp NOT NULL DEFAULT current_timestamp(),
+        \`updated_at\` timestamp NOT NULL DEFAULT current_timestamp() ON UPDATE current_timestamp(),
+        PRIMARY KEY (\`migration_id\`),
+        UNIQUE KEY \`MODULE_UNIQUE\` (\`module\`)
+        ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='Migration';
+    `);
+};