ecom-quickstart/index.js

A CLI tool to quickly set up a MERN eCommerce project

/**
 * Security and Safety Information:
 *
 * This npm package is designed to provide a secure and controlled method for downloading
 * and executing setup files from a private server. It is intended for users who have
 * an active subscription to our service.
 *
 * Key Security Measures:
 *
 * 1.  API Key Validation: All requests to our server require a valid API key, which is
 * validated against our authentication system. This ensures that only authorized
 * users can download and execute setup files.
 *
 * 2.  Server-Side File Hosting: Setup files are hosted on our private server, you can visit https://codeeasex.in, ensuring
 * that they are not included directly within the npm package. This prevents
 * unauthorized access and allows us to maintain control over file distribution.
 *
 * 3.  HTTPS Communication: All communication between the npm package and our server
 * is conducted over HTTPS, ensuring that data is encrypted and secure during
 * transmission.
 *
 * 4.  Controlled Execution: Setup files are only executed when the `installProject()`
 * function is explicitly called by the user. This prevents any automatic or
 * unintended execution of scripts.
 *
 * 5.  Input Sanitization: The API key and other inputs are sanitized to prevent
 * potential security vulnerabilities, such as command injection.
 *
 * 6.  Limited Permissions: The setup scripts themselves are designed to have minimal
 * permissions, reducing the risk of unintended system modifications.
 *
 * 7.  Cleanup Procedures: The package implements cleanup procedures to remove any
 * temporary files or directories created during the installation process,
 * ensuring that the user's system remains clean.
 *
 * 8.  No Arbitrary Downloads: This package does NOT download arbitrary files from
 * the internet. It only downloads files that are specifically requested by the
 * user via the `installProject()` function, and those files are only hosted on
 * our private server.
 *
 * 9.  Explicit User Action: The user is always in control. Nothing is downloaded or
 * executed without the explicit call to the installProject() function, with the
 * users API Key.
 *
 * 10. Transparency: All actions performed by this package are logged to the console,
 * providing transparency and allowing users to monitor the installation process.
 *
 * This package is designed to be a safe and reliable tool for our subscribers. We
 * are committed to maintaining the security and integrity of our service.
 */

import { installProject, setupProcessHandlers } from "./validate.js";

export { installProject };

setupProcessHandlers();

if (typeof module !== "undefined" && module.exports) {
  module.exports = { installProject };
}