Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
163 lines (102 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

163 lines (102 loc) · 3.5 KB

Contributing to Folo

Thank you for considering contributing to Folo! We welcome contributions from the community to help improve and expand the project.

Getting Started

Before you start contributing, please ensure you have enabled Corepack. Corepack ensures you are using the correct version of the package manager specified in the package.json.

corepack enable && corepack prepare

Installing Dependencies

To install the necessary dependencies, run:

pnpm install

Development Setup

Develop in the Browser

For a more convenient development experience, we recommend developing in the browser:

cd apps/desktop && pnpm run dev:web

This will open the browser at https://app.folo.is/__debug_proxy, allowing you to access the online API environment for development and debugging.

Develop in Electron

If you prefer to develop in Electron, follow these steps:

  1. Go to the apps/desktop directory:

    cd apps/desktop

  2. Copy the example environment variables file:

    cp .env.example .env

  3. Set VITE_API_URL to https://api.follow.is in your .env file.

  4. Run the development server:

    pnpm run dev:electron

Tip: If you encounter login issues, copy the __Secure-better-auth.session_token from your browser's cookies into the app.

Develop in External SSR Web App

To develop in SSR, follow these steps:

  1. Go to the apps/ssr directory:

    cd apps/ssr

  2. Run the development server:

    pnpm run dev

Develop in Mobile App

To develop in the mobile app, follow these steps:

Note

You need to have a Mac device to develop in the mobile app.

And already installed Xcode and the necessary dependencies.

  1. Go to the apps/mobile directory:

    cd apps/mobile

  2. Copy the example environment variables file:

    cp .env.example .env

    Then set the required environment variables in your .env file:

    echo 'EXPO_PUBLIC_APP_CHECK_DEBUG_TOKEN="xxx"' >> .env

    Or manually edit the .env file to add:

    EXPO_PUBLIC_APP_CHECK_DEBUG_TOKEN="xxx"

    the value is any string.

  3. Build and install Folo(dev) app from source: (This step will take a while and only need to be done once)

    pnpm expo prebuild --clean # Optional
pnpm run ios

  4. Run the development server:

    pnpm run dev

Development Native Modules

To develop native iOS modules, follow these steps:

  1. Go to the apps/mobile directory:

    cd apps/mobile/ios

  2. Open project in Xcode:

    open Folo.xcworkspace

  3. Open Pods in left sidebar and select FollowNative:

  1. Build and run the project.

Contribution Guidelines

  • Ensure your code follows the project's coding standards and conventions.
  • Write clear, concise commit messages.
  • Include relevant tests for your changes.
  • Update documentation as necessary.

Community

Join our community to discuss ideas, ask questions, and share your contributions:

We look forward to your contributions!

License

By contributing to Folo, you agree that your contributions will be licensed under the GNU Affero General Public License version 3, with the special exceptions noted in the README.md.