Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .eslintignore

This file was deleted.

12 changes: 0 additions & 12 deletions .eslintrc

This file was deleted.

18 changes: 3 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Created by https://www.toptal.com/developers/gitignore/api/node
# Edit at https://www.toptal.com/developers/gitignore?templates=node

### Node ###
# Logs
logs
*.log
Expand Down Expand Up @@ -106,6 +102,7 @@ dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus
Expand All @@ -132,14 +129,5 @@ dist
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

# End of https://www.toptal.com/developers/gitignore/api/node
.vercel
# Turborepo
.turbo/
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"typescript.enablePromptUseWorkspaceTsdk": false,
"typescript.tsdk": "node_modules/typescript/lib",

"eslint.workingDirectories": [{ "mode": "auto" }]
}
42 changes: 31 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,34 @@
# git-lfs-proxy
# Dairi: Self-Hosted Git LFS Proxy

Git LFS Proxy on Vercel Serverless Function.
Dairi - _**\[代理\] means proxy in Japanese**_ - is a small, simple, and customizable Git LFS Proxy for the Edges.
It works on Serverless Edge Platforms such as Cloudflare Workers, Deno, Vercel, AWS Lambda, Lambda@Edge, and Node.js.

## Environment Variables
```typescript
// app/api/[...route]/route.ts
import { Dairi } from "dairi";
import { vercel } from "@dairi/platform-vercel";

| Variable Name | Description |
| -------------------------- | ----------------------------- |
| `AWS_S3_ACCESS_KEY_ID` | AWS Access Key ID |
| `AWS_S3_SECRET_ACCESS_KEY` | AWS Secret Access Key |
| `AWS_S3_BUCKET` | The S3 bucket name |
| `AWS_S3_ENDPOINT` | The S3 endpoint |
| `AWS_S3_REGION` | The S3 region |
| `AWS_S3_SIGN_EXPIRE` | The S3 sign expire in seconds |
const app = new Dairi({ basePath: "/api" });

export const GET = vercel.get(app);
export const POST = vercel.post(app);

export const config = {
runtime: "edge",
};
```

## Packages

| package | description |
| ------------------------------------ | -------------------------------------------------------------------- |
| `dairi` | Application Entrypoint |
| `@dairi/core` | Dairi Core Package |
| **Storage** | |
| `@dairi/storage-s3` | LFS Storage for Amazon S3 (or compatible) |
| **Platform** | |
| `@dairi/platform-vercel` | Dairi for Vercel |

## License

MIT by [@6jz](https://twitter.com/6jz)
36 changes: 8 additions & 28 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,36 +1,16 @@
{
"name": "git-lfs.natsuneko.moe",
"version": "1.0.0",
"description": "Git LFS Proxy on Vercel Serverless Function",
"main": "index.js",
"repository": "https://github.com/natsuneko-laboratory/git-lfs-proxy.git",
"author": "Natsune Mochizuki",
"license": "MIT",
"private": true,
"name": "dairi",
"version": "1.0.0",
"description": "Dairi - [代理] means proxy in Japanese - is a small, simple, and customizable Git LFS Proxy for the Edges.",
"scripts": {
"build": "tsc",
"eslint": "eslint",
"prettier": "prettier"
"eslint": "turbo eslint",
"prettier": "turbo prettier",
"turbo": "turbo"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^5.12.1",
"@typescript-eslint/parser": "^5.12.1",
"@vercel/node": "^1.13.0",
"eslint": "^8.10.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-airbnb-typescript": "^16.1.0",
"eslint-config-prettier": "^8.4.0",
"eslint-plugin-import": "^2.25.4",
"prettier": "^2.5.1",
"typescript": "^4.5.5",
"vercel": "^24.0.0"
},
"dependencies": {
"@aws-sdk/client-s3": "^3.53.1",
"@aws-sdk/s3-request-presigner": "^3.53.1",
"@octokit/auth-token": "^3.0.2",
"@octokit/rest": "^18.12.0",
"ajv": "^8.10.0"
"turbo": "^1.10.15",
"typescript": "^5.2.2"
},
"volta": {
"node": "18.18.0"
Expand Down
29 changes: 29 additions & 0 deletions packages/eslint-config/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
const { resolve } = require("node:path");

const project = resolve(process.cwd(), "tsconfig.json");

module.exports = {
extends: ["airbnb-base", "eslint-config-prettier"],
ignorePatterns: ["node_modules/", "dist/"],
overrides: [
{
files: ["**/*.ts"],
extends: [
"airbnb-base",
"airbnb-typescript-base",
"plugin:import/typescript",
"eslint-config-prettier",
],
parser: "@typescript-eslint/parser",
parserOptions: {
project,
},
rules: {
"linebreak-style": ["off"],
"no-restricted-syntax": ["off"],

"import/prefer-default-export": ["off"],
},
},
],
};
21 changes: 21 additions & 0 deletions packages/eslint-config/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "@dairi/eslint-config",
"version": "1.0.0",
"description": "",
"private": true,
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"eslint": "^8.51.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-airbnb-typescript-base": "^4.0.2",
"eslint-config-prettier": "^9.0.0",
"eslint-plugin-import": "^2.28.1",
"prettier": "^3.0.3",
"typescript": "^5.2.2"
}
}
4 changes: 4 additions & 0 deletions packages/platform-vercel/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
root: true,
extends: ["@dairi"],
};
23 changes: 23 additions & 0 deletions packages/platform-vercel/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# `@natsuneko-laboratory/platform-vercel`

Vercel provider for Dairi.

```typescript
import { Dairi } from "dairi";
import { vercel } from "@dairi/platform-vercel";

const app = new Dairi({ basePath: "/api" });
app.use(vercel());

const handler = app.run();
export const GET = handler;
export const POST = handler;

export const config = {
runtime: "edge",
};
```

## License

MIT by [@6jz](https://twitter.com/6jz)
33 changes: 33 additions & 0 deletions packages/platform-vercel/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"name": "@dairi/platform-vercel",
"version": "1.0.0",
"description": "",
"license": "MIT",
"author": "Natsune Mochizuki <me@natsuneko.cat> (https://natsuneko.cat)",
"type": "module",
"exports": {
"import": "./dist/index.js",
"types": "./src/index.ts"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"tsc": "tsc"
},
"types": "./src/index.ts",
"dependencies": {
"hono": "^3.7.5"
},
"peerDependencies": {
"@dairi/core": "workspace:^"
},
"devDependencies": {
"@dairi/core": "workspace:^",
"@dairi/eslint-config": "workspace:^",
"@dairi/tsconfig": "workspace:^",
"typescript": "^5.2.2"
},
"keywords": [],
"publishConfig": {
"access": "public"
}
}
11 changes: 11 additions & 0 deletions packages/platform-vercel/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { handle } from "hono/vercel";

import type { DairiPlatformMiddleware } from "@dairi/core";

const vercel = (): DairiPlatformMiddleware => ({
name: "vercel-platform",
type: "platform",
getHandler: (server) => handle(server),
});

export { vercel };
6 changes: 6 additions & 0 deletions packages/platform-vercel/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": "@dairi/tsconfig",
"compilerOptions": {
"moduleResolution": "Node16"
}
}
4 changes: 4 additions & 0 deletions packages/storage-s3/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
root: true,
extends: ["@dairi"],
};
34 changes: 34 additions & 0 deletions packages/storage-s3/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"name": "@dairi/storage-s3",
"version": "1.0.0",
"description": "",
"license": "MIT",
"author": "Natsune Mochizuki <me@natsuneko.cat> (https://natsuneko.cat)",
"type": "module",
"exports": {
"import": "./dist/index.js",
"types": "./src/index.ts"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"tsc": "tsc"
},
"types": "./src/index.ts",
"dependencies": {
"@aws-sdk/client-s3": "^3.427.0",
"@aws-sdk/s3-request-presigner": "^3.427.0"
},
"peerDependencies": {
"@dairi/core": "workspace:^"
},
"devDependencies": {
"@dairi/core": "workspace:^",
"@dairi/eslint-config": "workspace:^",
"@dairi/tsconfig": "workspace:^",
"typescript": "^5.2.2"
},
"keywords": [],
"publishConfig": {
"access": "public"
}
}
Loading