https://github.com/davidkk/vercel-web-scripts

https://github.com/davidkk/vercel-web-scripts

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/davidkk/vercel-web-scripts
• Owner: DavidKk
• License: mit
• Created: 2025-02-04T13:33:51.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-03-22T17:10:51.000Z (about 2 months ago)
• Last Synced: 2025-03-22T18:23:04.272Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://vercel-web-scripts.vercel.app
• Size: 309 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/DavidKk/vercel-web-scripts/actions/workflows/coverage.workflow.yml/badge.svg)](https://github.com/DavidKk/vercel-web-scripts/actions/workflows/coverage.workflow.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![中文](https://img.shields.io/badge/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87-green?style=flat-square&logo=docs)](https://github.com/DavidKk/vercel-web-scripts/blob/main/README.zh-CN.md) [![English](https://img.shields.io/badge/docs-English-green?style=flat-square&logo=docs)](https://github.com/DavidKk/vercel-web-scripts/blob/main/README.md)

# Vercel Web Scripts

Mainly used for managing and deploying custom scripts on Vercel.

## Features

- **Script Management**: Centrally manage private scripts, sync to multiple clients, and support online modification with instant synchronization. Since the content is stored in private GitHub Gist, it is not absolutely secure. Please do not store any sensitive information (such as API keys, passwords, etc.) and use it only for non-sensitive functional scripts.

- **Script Packaging**: Automatically generate script entry, support multi-script packaging. (Currently only supports Tampermonkey)

## Security Notes

- Script content is stored in private GitHub Gist, but GitHub employees and anyone with account access can still view the content.

- **Do not store any sensitive information** (such as API keys, passwords, etc.), it is recommended to use it only for non-sensitive functional scripts.

- Ensure the Gist Token has minimal permissions (only need gist scope) and rotate the keys regularly.

## Deploy to Vercel

[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDavidKk%2Fvercel-web-scripts)

### Environment Variable Configuration

Refer to the [`.env.example`](./.env.example) file to set the required environment variables.

- `GIST_ID`: GitHub Gist Id

- `GIST_TOKEN`: GitHub Gist Token

- `ACCESS_USERNAME`: Admin Username

- `ACCESS_PASSWORD`: Admin Password

- `ACCESS_2FA_SECRET`: 2FA Secret, can generate TOKEN using [https://vercel-2fa.vercel.app](https://vercel-2fa.vercel.app)

- `JWT_SECRET`: JWT Secret

- `JWT_EXPIRES_IN`: JWT Token Expiration Time

## Quick Start

1. Create a **GitHub Gist** and generate a **GitHub Access Token** (with gist permission).

2. Set the corresponding environment variables in Vercel.

3. Once deployed, you can manage scripts through the generated configuration (recommended to use in non-public network environments).