From 588d2da95c023c78d8cebbe1b099781a295046fc Mon Sep 17 00:00:00 2001 From: Stephen Zhou <38493346+hyoban@users.noreply.github.com> Date: Fri, 21 Mar 2025 17:13:25 +0800 Subject: [PATCH] docs: link to CONTRIBUTING.md (#3217) --- README.md | 41 +---------------------------------------- 1 file changed, 1 insertion(+), 40 deletions(-) diff --git a/README.md b/README.md index 1d8e62d74..a84e2a51b 100644 --- a/README.md +++ b/README.md @@ -87,46 +87,7 @@ This isn’t just another app. Follow is a community — introducing a new era o ## 🤝 Contributing -If you are eligible to use Follow, you are welcome to join the open source community to build together. - -Before you start, make sure you have enabled [Corepack](https://nodejs.org/api/corepack.html). Corepack makes sure you are using the correct version (`packageManager` field in `package.json`) for package manager when you run corresponding commands. - -```sh -corepack enable -``` - -Install dependencies. - -```sh -pnpm install -``` - -### Develop in the browser - -```sh -pnpm run dev -``` - -Then the browser opens `https://app.follow.is/__debug_proxy`,you can access the online API environment to development and debugging. - -### Develop in the electron - -You need to fill in the required environment variables first. - -```sh -cp .env.example .env -``` - -Then set `VITE_API_URL` to `https://api.follow.is` and run: - -```sh -pnpm run dev:electron -``` - -Since it is not very convenient to develop in Electron, the first way to develop and contribute is recommended at this stage. - -> [!TIP] -> If you can't log in to the app, copy the `__Secure-better-auth.session_token` in the cookie from your browser into the app. +You are welcome to join the open source community to build together, please check our [Contributing Guide](./CONTRIBUTING.md) for more details. ## 📝 License