Skip to main content

Local Setup

Prerequisites​

  1. Download and install Git
    This will be used to download the repository

  2. Download and install Node
    This will be used to run the local server. It included the npm package manager

    tip

    The recommended version of node to use is node 22.18 as this is what also runs in the production environment. If running a higher version and experiencing issues please file a bug report.

    You can use tools like
    nodenv
    fnm
    nvm
    to run multiple versions of node on the same machine

  3. Download and install Yarn (v3)

  4. Follow supabase.md to setup a "Local supabase instance"

Run locally​

Clone the repo

git clone https://github.com/ONEARMY/community-platform

Change directory into the cloned repo to run future commands

cd community-platform

Install dependencies

yarn install

Run the platform

yarn start

Module not found​

If whilst attempting to run the app a module-not-found (or similar) error appears, it is likely because dependencies have been updated and require install again. Running the yarn install command again should fix.

Error: ENOENT: no such file or directory​

If you see an error message suggesting that a particular folder/file could not be installed, there is a chance that the previous command would have installed/fixed anyway and things might just work.

If they don't, then try deleting the node_modules folder in the workspace mentioned in the error message (e.g. ./packages/documentation/node_modules or similar)