https://github.com/frkn-dev/site

frkn.org - main website for FRKN project
https://github.com/frkn-dev/site

shadowsocks v2ray vless vmess vpn xray

Last synced: 3 months ago
JSON representation

frkn.org - main website for FRKN project

• Host: GitHub
• URL: https://github.com/frkn-dev/site
• Owner: frkn-dev
• License: other
• Created: 2024-06-30T17:29:17.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-22T00:19:46.000Z (3 months ago)
• Last Synced: 2024-09-25T21:20:45.702Z (3 months ago)
• Topics: shadowsocks, v2ray, vless, vmess, vpn, xray
• Language: TypeScript
• Homepage: https://frkn.org
• Size: 1.89 MB
• Stars: 38
• Watchers: 5
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## Dev-mode

```sh

cp .env.example .env

docker-compose up -d

pnpm install

pnpm run prisma:push

pnpm run dev

```

### Requirements

[Node.js LTS](https://nodejs.org) and [pnpm](https://pnpm.io/installation#using-npm). IDE with [TypeScript](https://code.visualstudio.com/docs/languages/typescript) and [Biome](https://biomejs.dev/guides/integrate-in-editor/) support.

To automatically format code, it is important to properly configure your IDE. See an example for VS Code (`.vscode/settings.json`).

### Stack

- [Next.js](https://nextjs.org/docs/getting-started/project-structure#app-routing-conventions) app Routing Conventions

- [Prisma ORM](https://www.prisma.io/docs/orm/overview/introduction/what-is-prisma)

- [FSD](https://feature-sliced.design/ru/docs/get-started/overview) folder structure

### DB

Run migrations when the schema changes. For local development, use Docker with PostgreSQL and pgAdmin (`localhost:5050`) or `npx prisma studio`.

## Build

```sh

pnpm run build

```

The project is automatically deployed to Vercel upon merging into the main branch.

### Security

The `pnpm test` command includes a package audit. Additionally, to ensure the security of our project, periodically update packages using `ncu` ([npm-check-updates](https://www.npmjs.com/package/npm-check-updates)) and [scan](https://www.npmjs.com/package/snyk) them with `snyk test`