@maxpeterkaya/web-proxy 1.0.3 → 1.0.4

package/INSTALL-GUIDE.md

@@ -8,29 +8,42 @@ version through commands.
 
 ### Step 1
 
-Install: ``npm i @maxpeterkaya/web-proxy concurrently``
+Install: ``npm i @maxpeterkaya/web-proxy``
 
 While running ``npm i``, it will automatically download the latest binary with execution permissions.
 
-Currently you need to run your app and web-proxy through concurrently to ensure both are running concurrently.
 
 ### Step 2
 
-Add the following scripts to your package.json:
+> You can run your web app either through web-proxy or concurrently. To run your app through web-proxy, pass the **-app
+** argument.
+
+Add the following scripts to your package.json to run your app through web-proxy:
 
 ```json
 {
   "scripts": {
-    "start:proxy": "./node_modules/.bin/web-proxy",
     "start:web": "YOUR COMMAND TO START YOUR APP",
-    "start": "concurrently --prefix none \"npm run start:web\" \"npm run start:proxy\""
+    "start": "npx web-proxy -app"
   }
 }
 ```
 
-You can view the docs for concurrently [here](https://github.com/open-cli-tools/concurrently/tree/main/docs).
+Add the following scripts to your package.json to run your app and web-proxy concurrently:
+
+Install: ``npm i concurrently``
+
+```json
+{
+  "scripts": {
+    "start:proxy": "npx web-proxy",
+    "start:web": "YOUR COMMAND TO START YOUR APP",
+    "start": "concurrently --prefix none \"npm run start:web\" \"npm run start:proxy\""
+  }
+}
+```
 
-#
+> You can view the docs for concurrently [here](https://github.com/open-cli-tools/concurrently/tree/main/docs).
 
 In the future web-proxy will be able to start your web app itself without the use of concurrently.
 

package/README.md

@@ -1,7 +1,7 @@
 # Web-proxy
 
-[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/web-proxy)](https://artifacthub.io/packages/search?repo=web-proxy)
-
+[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/web-proxy)](https://artifacthub.io/packages/search?repo=web-proxy) ![image](https://vc.maxkaya.com/maxpeterkaya/web-proxy/badges/release.svg) ![image](https://vc.maxkaya.com/maxpeterkaya/web-proxy/badges/workflows/ci.yml/badge.svg) ![image](https://vc.maxkaya.com/maxpeterkaya/web-proxy/badges/pulls/open.svg)
+![image](https://vc.maxkaya.com/maxpeterkaya/web-proxy/badges/issues/open.svg)
 ## Introduction
 
 This project aims to provide a better logging solution to web applications that lack structured logs.
@@ -12,11 +12,35 @@ Some of these frameworks may include:
 - NextJS
 - PrismaORM
 
-## [Installation Guide](https://github.com/maxpeterkaya/web-proxy/blob/main/INSTALL-GUIDE.md)
+## Getting Started
+
+### NodeJS
+
+Install: ``npm i @maxpeterkaya/web-proxy``
+
+Add the following scripts to your ``package.json``:
+
+```json
+{
+  "scripts": {
+    "start": "npx web-proxy -app",
+    // Passing the -app is very important to tell web-proxy to run the web app for you.
+    "start:web": "YOUR COMMAND TO START THE WEB APP"
+    // This could be next start, remix-serve build, ng serve, node dist/main, etc.
+  }
+}
+```
+
+After doing so, make sure web-proxy is properly configured
+
+## [Installation Guide](https://vc.maxkaya.com/maxpeterkaya/web-proxy/src/branch/main/INSTALL-GUIDE.md)
 
 ## Examples
 
-- [Container middleware](https://github.com/maxpeterkaya/web-proxy/tree/main/examples/container-middleware)
+- [Container middleware](https://vc.maxkaya.com/maxpeterkaya/web-proxy/src/branch/main/examples/container-middleware)
+- [Static website](https://vc.maxkaya.com/maxpeterkaya/web-proxy/src/branch/main/examples/static-website)
+- [Authentication](https://vc.maxkaya.com/maxpeterkaya/web-proxy/src/branch/main/examples/authentication)
+- [Container proxy](https://vc.maxkaya.com/maxpeterkaya/web-proxy/src/branch/main/examples/container-proxy)
 
 ## Roadmap
 
@@ -28,5 +52,4 @@ These bullet points are in no particular order of importance or difficulty.
 - Templates
 - Screenshots
 - Benchmarks
-- Configurable logs
-- NPM package
+- Configurable logs

package/bin/install.js

@@ -24,7 +24,7 @@ if (!assetName) {
     process.exit(1);
 }
 
-const url = `https://github.com/maxpeterkaya/web-proxy/releases/latest/download/web-proxy_${assetName}`;
+const url = `https://vc.maxkaya.com/maxpeterkaya/changelog/releases/download/latest/web-proxy_${assetName}`;
 const destDir = path.join(__dirname);
 const destFile = path.join(destDir, `${platform === "win32" ? "web-proxy.exe" : "web-proxy"}`);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxpeterkaya/web-proxy",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Server middleware enabling better logging for web apps through structured logs",
   "bin": {
     "web-proxy": "bin/run.js"
@@ -11,7 +11,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/maxpeterkaya/web-proxy"
+    "url": "https://vc.maxkaya.com/maxpeterkaya/web-proxy"
   },
   "keywords": [
     "nextjs",
@@ -28,7 +28,7 @@
   "private": false,
   "author": {
     "name": "Max Kaya",
-    "email": "info@maxkaya.com"
+    "email": "git@maxkaya.com"
   },
   "license": "Apache-2.0"
 }

package/renovate.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json"
+}