Reading the repo
Reading the repo
Assembly instructions
For empowering community 🌱
Saved setup from 2 h ago
The maintainers included bin/setup. Open it to see how it's meant to be run: bin/setup on GitHub.
Will it work on my device?
Needs Git: xcode-select --install
git clone https://github.com/forem/forem.git cd forem
Node.js 22.23.4, Ruby 3.3.0
brew install mise mise install
Needs: Redis
brew install --cask docker # Docker Desktop docker compose -f docker-compose.yml up -d
corepack enable yarn install bundle install
bin/rails db:prepare
bin/dev
yarn test bin/rails test
This section provides a high-level quick start guide. If you're looking for a more thorough installation guide (for example with macOS), you'll want to refer to our complete Developer Documentation.
We run on a Rails backend, and we are currently transitioning to a Preact-first frontend.
Prerequisites Note: Forem now utilizes advanced AI embeddings for feed generation. You must ensure your PostgreSQL installation has the pgvector extension (version 0.8.0 or higher) installed to support HNSW indexing. This database extension is a hard requirement to migrate the database and run the app.
To install pgvector:
brew install pgvectorsudo apt install postgresql-15-pgvector (adjust 15 to match your installed PostgreSQL version), or compile from source following the pgvector installation guide.However, providing a Gemini API key (GEMINI_API_KEY) to actually generate the embeddings is completely optional; if omitted, the app will continue to function normally without semantic recommendations.
A more complete overview of our stack is available in our docs.
To launch Forem in Gitpod, please navigate to https://gitpod.io/#https://github.com/{your_github_username}/forem.
To launch Forem in Ona (formerly Gitpod), the project is fully configured for Ona development environments. Simply open the project in Ona and the environment will be automatically configured with all necessary services and dependencies.
Please see our installation guides:
No reports for macOS yet.
Claude reads the 16 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.