Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 3.5 KB

README.md

File metadata and controls

92 lines (59 loc) · 3.5 KB
Raw

aero

aero logo

Aero is a safe, developer-friendly, innovative interception web proxy with many features. Aero provides full site support without delay and has a clean, organized codebase. Aero is made to bypass filter restrictions, web restrictions, and bypasses web browser restrictions.

I'm only quitting proxy dev once aero supports everything. AeroSandbox can sandbox everything (remove all web restrictions, too), and my Proxy Dev Guide is so detailed with examples that it contains explanations and code examples to make your proxy that supports everything.

What is a web proxy?

Web proxies are website libraries that work to emulate the functionality of the site that you want. They do this by intercepting API calls and rewriting documents to emulate as if it was under the proxied origin.

Web Proxies can be used for:

  • Bypassing any browsing restrictions in a sandbox
  • Unblocking websites or browser features through emulation
  • Middleware

How to build aero

npm i
npm run buildSW
npm --profile=src/AeroSandbox i
npm --profile=src/AeroSandbox run build

Since these are production builds the bundles will be in ...dist/prod/... ⚠️ There are currently issues building aero with pnpm, so please refrain from using it at the moment

How to live debug aero (how to run the aero dev server)

⚠️ This dev server isn't meant to be used as a demo, but it certainly can be if you run without the live build scripts. You can pre-build the production builds and run npm run buildSW. There will be an actual demo server like described here. Be sure to enable Source Maps when debugging

  1. Install pm2
  2. Execute these commands
./deps.sh
npm start

Run git pull and then run these commands again to update the dev server The port by default is :2525

To debug the bundles

Run

npm run rsdoctor

You should share those Rsdoctor ports if you are on a VSCode live share with collaborators

How to build with your own feature flags

TODO: Rename createFeatureFlags.ts to createDefaultFeatureFlags.ts TODO: Encourage creating createFeatureFlags.ts, which can override what is in createDefaultFeatureFlag.ts TODO: Normally import createDefaultFeatureFlags.ts and dynamically import createFeatureFlags.ts THEN run the rest of the build code TODO: Do the same for AeroSandbox

With VSCode

./deps.sh

In your editor: Press f5 or Menu -> Run -> Start Debugging

Notes

  • You must run pm2 restart <aero-build-watch/aero-sandbox-build-watch> whenever you modify a compile-time Feature Flag for it to apply regardless if you are in a live build

How to run unit tests

Related

It is highly recommended that you install aero middleware for enhanced functionality.

Notable Contributions

Don't be afraid to help 😄 Nobody is unqualified to work on aero Don't worry; you will figure out how aero works with our fantastic dev docs. Remember, if you have ideas for how to improve the docs, please suggest them I appreciate all of you 💖