@misterzik/espressojs 3.1.11 → 3.1.14

package/.env

@@ -1 +1,6 @@
 MONGO_URI=USER:PASSWORD@DOMAIN.mongodb.net
+MONGO_URI_PORT=27017
+MONGO_URI_DB=clients
+API_URI_ON=FALSE
+API_URI=
+PORT=8080

package/README.md

@@ -1,56 +1,66 @@
-
-![Espresso](Espresso-Logo.png)
+![Espresso](https://raw.githubusercontent.com/misterzik/Espresso.js/main/espresso-logo.png)
 
 ## EspressoJS / Espresso
-  
-
-### EspressoJS / Espresso It's your one-stop Express Configuration Boiler-Plate, plug-and-play configuration to get you started with hosting your front-end projects. Barebones configuration with the option to scale up using MongoDB.
 
-#### Express Server boiler-plate with some beans for fiber. This ain't Goya!.  (mongoDB Ready)
+### EspressoJS / Espresso is your one-stop Express Configuration starting point or boilerplate. Simple, and unopinionated, EspressoJS plug-and-play configurations are based on Express. Espresso will get you started with an Express instance in seconds.
 
-### Getting Started
+## Getting Started
 
+- Download [latest release](https://github.com/misterzik/Espresso.js/packages/364567)
 
-* Download [latest release](https://github.com/misterzik/Espresso.js/tags) or in your bash of choice; $ git clone Espresso.js
+  `npm install --save @misterzik/espressojs`
 
-  
+- Create `config.json` to handle the instances
 
-   `git clone https://github.com/misterzik/Espresso.js.git`
+  ```
+  {
+    "instance":"global",
+    "port":8080
+  }
+  ```
 
-  
+- Create `.env` if you don't want to use config. A mix is possible.
 
-* Change directory to new cloned repository by using your command line of choice. (NodeJS is Require to be installed.)
+  ```
+  MONGO_URI=USER:PASSWORD@DOMAIN.mongodb.net
+  MONGO_URI_PORT=27017
+  MONGO_URI_DB=clients
+  API_URI_ON=FALSE
+  API_URI=
+  PORT=8080
+  ```
 
-  `cd "YOUR-PATH"/Espresso.js`
+- Create `espresso.js` and add the following requirements to call the packages.
 
-* Once in Espresso.js folder, Install project dependencies by typing;
+  ```
+  require("@misterzik/espressojs");
+  ```
 
-  `npm install`
+- Create `cli.js` and add the following requirements to call the packages.
 
-  
+  ```
+  require('@misterzik/espressojs/cli');
+  ```
 
-* After installing all dependencies from Espresso, You are ready to run it, before hand I left you three files that can/should be modified to your liking; 
+- And you are all set to start, To run the instance, use:
+  ```
+  node cli run
+  ```
 
-  Pre-made Configurations:
-  * `server/config/config.global.js`
-  * `server/config/config.production.js`
-  * `server/config/config.development.js`
 
-  Let's run the demo from the files included, we can start by bundling the demo JavaScript located `/public/assets/js/` by typing on your terminal `npm run webpack-dev`this will bundle the JavaScript needed for the `index.html`.
-
-* Run project Without MongoDB, by running `npm start`, If you would like to run instance with MongoDB run `npm run dev` or `npm run prod` .
- 
-   Note: If you use MongoDB you have to edit the following file with your MongoDB instance credentials;
-   `server/config/config.production.js` or `server/config/config.development.js`
+### Structured Files
 
+  Pre-made Configurations:
 
-* Stop server by pressing `CTRL + C` to terminated the Espresso process.
+  - `server/config/config.global.js`
+  - `server/config/config.production.js`
+  - `server/config/config.development.js`
 
-  
+### Commands
 
-### Requirements 
+- Stop server by pressing `CTRL + C` to terminated the Espresso process.
 
- * NodeJS
- * NPM
+### Requirements
 
-Make sure you already have NodeJS/NPM installed. MongoDB installed on your system in the case you desired to use the Express MongoDB Integration provided.s
+- NodeJS
+- NPM

package/index.js

@@ -8,25 +8,28 @@
  */
 
 const fs = require("fs");
+require("dotenv").config();
 const express = require("express");
 const app = express();
 const cfg = require("./server");
-
-require("dotenv").config();
-
 const configBuffer = fs.readFileSync("./config.json"),
   configJSON = configBuffer.toString(),
   configData = JSON.parse(configJSON);
 
-const _path = require("path"),
-  _cors = require("cors"),
-  _compr = require("compression"),
-  _favicon = require("serve-favicon"),
-  _static = require("serve-static"),
-  _port = configData.port || process.env.PORT || cfg.port,
-  _routes = require("./server/routes/index");
+const Path = require("path"),
+  Cors = require("cors"),
+  Compression = require("compression"),
+  Favicon = require("serve-favicon"),
+  Static = require("serve-static"),
+  Port = configData.port || process.env.PORT || cfg.port,
+  Routes = require("./routes/index");
 
 const mongoose = require("mongoose");
+const setCustomCacheControl = (res, path) => {
+  if (Static.mime.lookup(path) === "text/html") {
+    res.setHeader("Cache-Control", "public, max-age=0");
+  }
+};
 
 if (cfg.mongo_isEnabled == true) {
   let hasPort, hasUri;
@@ -40,7 +43,6 @@ if (cfg.mongo_isEnabled == true) {
   } else {
     hasUri = cfg.mongo.uri;
   }
-
   const url = `mongodb+srv://${hasUri + hasPort + cfg.mongo.db}`;
   mongoose.Promise = global.Promise;
   mongoose
@@ -53,14 +55,13 @@ if (cfg.mongo_isEnabled == true) {
     .catch((err) => console.error(err));
 }
 
-app.use(_compr());
-app.use(_cors());
+app.use(Compression());
+app.use(Cors());
 app.use(express.urlencoded({ extended: false }));
 app.use(express.json());
-app.use(_favicon(_path.join(__dirname, "public", "favicon.ico")));
-
+app.use(Favicon(Path.join("./public", "favicon.ico")));
 app.use(
-  _static(_path.join(__dirname, "public"), {
+  Static(Path.join("./public"), {
     maxAge: "1d",
     setHeaders: setCustomCacheControl,
     etag: true,
@@ -68,13 +69,6 @@ app.use(
   })
 );
 
-function setCustomCacheControl(res, path) {
-  if (_static.mime.lookup(path) === "text/html") {
-    res.setHeader("Cache-Control", "public, max-age=0");
-  }
-}
-
-_routes(app);
-app.listen(_port);
-
+Routes(app);
+app.listen(Port);
 module.exports = app;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@misterzik/espressojs",
-    "version": "3.1.11",
+    "version": "3.1.14",
     "description": "EspressoJS / Espresso It's your one-stop Express Configuration Boiler-Plate, plug-and-play configuration to get you started with hosting your front-end projects. This is a barebones configuration with the option to scale up using MongoDB.",
     "main": "index.js",
     "scripts": {
@@ -54,11 +54,7 @@
         "@babel/core": "^7.16.0",
         "amd-define-factory-patcher-loader": "^1.0.0",
         "babel-loader": "^8.2.3",
-        "babel-preset-env": "^1.7.0",
-        "jquery": "^3.6.0",
-        "terser-webpack-plugin": "^4.2.3",
-        "webpack": "^5.64.0",
-        "webpack-cli": "^4.9.1"
+        "babel-preset-env": "^1.7.0"
     },
     "engines": {
         "node": ">= 0.10.0"

package/{server/routes → routes}/api/index.js

@@ -7,13 +7,13 @@
  */
 
 const express = require("express");
-const cfg = require("./../../../server");
-const router = express.Router();
 const axios = require("axios");
+const router = express.Router();
+const configuration = require("../../server");
 
 const getAPI = (req, res) => {
   axios
-    .get(cfg.swapi.uri, cfg.swapi.configs)
+    .get(configuration.swapi.uri, configuration.swapi.configs)
     .then(function (response) {
       if (response.status == 200) {
         res.json(response.data);
@@ -26,7 +26,7 @@ const getAPI = (req, res) => {
 
 const getItem = (req, res, params) => {
   axios
-    .get(cfg.swapi.uri + "/" + params, cfg.swapi.configs)
+    .get(configuration.swapi.uri + "/" + params, configuration.swapi.configs)
     .then(function (response) {
       if (response.status == 200) {
         res.json(response.data);
@@ -39,7 +39,10 @@ const getItem = (req, res, params) => {
 
 const getItemId = (req, res, params, paramsId) => {
   axios
-    .get(cfg.swapi.uri + params + "/" + paramsId + "/", cfg.swapi.configs)
+    .get(
+      configuration.swapi.uri + params + "/" + paramsId + "/",
+      configuration.swapi.configs
+    )
     .then(function (response) {
       if (response.status == 200) {
         res.json(response.data);
@@ -49,15 +52,12 @@ const getItemId = (req, res, params, paramsId) => {
     })
     .catch((err) => res.send(err));
 };
-
 router.get("/v1/", (req, res) => {
   getAPI(req, res);
 });
-
 router.get("/v1/:item", (req, res, next) => {
   getItem(req, res, req.params.item);
 });
-
 router.get("/v1/:item/:itemId", (req, res, next) => {
   getItemId(req, res, req.params.item, req.params.itemId);
 });

package/{server/routes → routes}/db/index.js

@@ -2,13 +2,15 @@
  * EspressoJS - Hippie's Fav Server Plate
  * Powered by Vimedev.com Labs
  * ---
- * Client Model -- Basic Clients Collection - API CRUD
+ * Client Model - WIP
+ * -- 
+ * Basic Clients Collection - API CRUD
  * ---
  * @param {*} app - Vimedev.com Labs
  */
 
 module.exports = (app) => {
-  const clientRouter = require("../../controllers/client/client.controller.js");
+  const clientRouter = require("../../server/controllers/client/client.controller.js");
   const preFix = "/api/clients/",
     url = preFix;
 

package/{server/routes → routes}/index.js

@@ -8,20 +8,20 @@
  */
 
 module.exports = (app) => {
-  const cfg = require("./../../server"),
-    path = require("path"),
+  const configuration = require("../server"),
+    Path = require("path"),
     api = require("./api");
 
   app.get("/", function (res) {
-    res.sendFile("index.html", { root: path.join("./public") });
+    res.sendFile("index.html", { root: Path.join("./public") });
   });
 
-  if (cfg.swapi_isEnabled == true) {
+  if (configuration.swapi_isEnabled == true) {
     app.use("/api", api);
   }
 
   require("./db")(app);
-  require("./../utils/global.message")(app);
+  require("../server/utils/global.message")(app);
 
   app.use(function (req, res, next) {
     res.status(404).send("404 - Sorry can't find that!");

package/server/controllers/client/client.controller.js

@@ -2,7 +2,7 @@
  * EspressoJS - Hippie's Fav Server Plate
  * Powered by Vimedev.com Labs
  * ---
- * MongoDB Client Controller
+ * MongoDB Client Controller - WIP
  */
 
 const Client = require("../../models/client.model.js");

package/public/assets/css/style.css

@@ -1,10 +0,0 @@
-html {
-    background-image: linear-gradient(to left top, #214780, #23569a, #2366b4, #1f77cf, #1288eb);
-}
-
-.logo {
-    width: 26px;
-    margin-top: -1rem;
-    margin-left: 1rem;
-    margin-bottom: 1rem;
-}

package/public/assets/js/jQuery/index.js

@@ -1,31 +0,0 @@
-/*
- * Vimedev.com Labs
- * ----------------
- * jQuery Unminified File
- */
-
-$(document).ready(function () {
-  console.log("EspressoJS is ready to be modified!");
-  /*
-   * Vimedev.com Labs
-   * ----------------
-   *  Placeholder Code
-   *  /\/\isterzik
-   */
-  const _firstName = "Two";
-  const _lastName = "Way";
-
-  function updateFullName() {
-    const fullName = $("#firstName").val() + " " + $("#lastName").val();
-    $("#fullName").text(fullName);
-  }
-
-  $("#firstName").val(_firstName);
-  $("#lastName").val(_lastName);
-
-  $("#firstName, #lastName").keyup(() => {
-    updateFullName();
-  });
-
-  updateFullName();
-});

package/public/assets/js/jQuery/other-file.js

@@ -1,9 +0,0 @@
-/*
- * Vimedev.com Labs
- * ----------------
- * jQuery Unminified File
- */
-
-$(document).ready(function () {
-  console.log("EspressoJS Second JS Sample!");
-});

package/public/index.html

@@ -1,60 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <title>Espresso.JS by VMD - Express JS Plug & Play Node Server for DevOps</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <!-- Stylesheets -->
-    <link
-      href="https://fonts.googleapis.com/icon?family=Material+Icons"
-      rel="stylesheet"
-    />
-    <link
-      rel="stylesheet"
-      href="https://cdn.rawgit.com/Chalarangelo/mini.css/v3.0.0/dist/mini-default.min.css"
-    />
-    <link rel="stylesheet" href="/assets/css/style.css" />
-  </head>
-
-  <body>
-    <h1>
-      <img src="assets/images/Espresso-Logo.png" alt="Espresso" />
-    </h1>
-    <h4>
-      <b>(Es)</b>presso It's your one-stop Express Configuration Boiler-Plate,
-      plug-and-play configuration to get you started with hosting your front-end
-      projects. This is barebones configuration with the option to scale up
-      using mongoDB.
-    </h4>
-    <div class="container">
-      <div class="row">
-        <div class="col-sm-6">
-          <blockquote cite="www.vimedev.com">
-            <h1>Full Name:</h1>
-            <h3>
-              <span id="fullName"></span>
-            </h3>
-          </blockquote>
-        </div>
-        <div class="col-sm-3">
-          First Name:
-          <br />
-          <input id="firstName" />
-          <br />
-          <br />
-          Last Name:
-          <br />
-          <input id="lastName" />
-        </div>
-        <div class="col-sm-3"></div>
-      </div>
-    </div>
-    <br />
-    <a href="https://vimedev.com/" target="_blank">
-      <img src="/assets/images/vimedev-logo.png" alt="Vimedev" class="logo" />
-    </a>
-    <!-- Javascript Bundles - Generated by Webpack -->
-    <script src="/assets/src/app.bundle.js"></script>
-    <script src="/assets/src/vendor.bundle.js"></script>
-  </body>
-</html>

package/webpack.config.js

@@ -1,51 +0,0 @@
-/**
- * EspressoJS - Powered by Vimedev.com Labs
- * ---
- * Basic Web-Pack Configuration Declarations
- * ---
- *
- */
-
-const webpack = require("webpack");
-const path = require("path");
-const TerserPlugin = require("terser-webpack-plugin");
-
-/**
- * EspressoJS - Powered by Vimedev.com Labs
- * ---
- * Configuration Usage
- */
-const config = {
-  context: path.resolve(__dirname, "./public/assets/js/jQuery"),
-  entry: {
-    app: "./index.js",
-    vendor: "./other-file.js",
-  },
-  output: {
-    filename: "[name].bundle.js",
-    path: path.resolve(__dirname, "./public/assets/src"),
-  },
-  plugins: [
-    new webpack.ProvidePlugin({
-      $: "jquery",
-      jquery: "jQuery",
-      "window.jQuery": "jquery",
-    }),
-  ],
-  module: {
-    rules: [
-      {
-        test: /jquery[\\\/]src[\\\/]selector\.js$/,
-        loader: "amd-define-factory-patcher-loader",
-      },
-      {
-        test: /\.js$/,
-        exclude: /(node_modules|bower_components)/,
-        use: {
-          loader: "babel-loader",
-        },
-      },
-    ],
-  },
-};
-module.exports = config;