xiaoxue_admin
/
Folo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: link to CONTRIBUTING.md (#3217)

This commit is contained in:
Stephen Zhou 2025-03-21 17:13:25 +08:00 committed by GitHub
parent c901414c71
commit 588d2da95c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -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