Skip to content

A powerful web proxy built for speed and customization.

License

Notifications You must be signed in to change notification settings

Zzza38/Metallic

Repository files navigation

Metallic

A powerful web proxy built for speed and customization.

Access the web with this stylish web proxy made in Preact supporting many sites. Metallic was originally created for TN's proxathon where it won 2nd place!

Features

  • Modern, clean design
  • Support for many popular sites
  • Customizable interface
  • Mobile support
  • Expansive library of themes

Setup

Tip

Run npm install to install the required dependencies.

Run

Run npm start to start the server. If no build if found, Metallic will attempt to build.

Build

Run npm run build to build app for production into the build folder.

Development

Run npm run dev to run the app in development mode. Rammerhead will not work in this mode.

Configuration

Themes

Themes can be changed from the /src/themes.json file. The file should be an array of objects using the format below.

Important

Themes file will validated before building, starting the server, or starting the dev server.

{
    "name": "string", # Display name of theme
    "id": "string", # Unique ID of theme
    "theme": {
        "background": "string", # Background color of site
        "secondary": "string", # Buttons and inputs
        "primary": "string", # Icons amd logo
        "text": "string", # Text color
        "textInverse": "string", # Text color for buttons and inputs
        "font": "string" # Font for website (default is "Roboto")
    },
    "custom": { # Optional
        "selector": { # CSS selector (".nav" for example)
            "key": "string" # CSS key and value ("background": "red" for example)
        }
    }
}

Changelog/Roadmap

Check out the changelog and roadmap

License

Metallic uses the MIT license.

About

A powerful web proxy built for speed and customization.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.3%
  • JavaScript 5.1%
  • CSS 1.9%
  • Other 0.7%