Skip to main content

Prerequisites

Before installing FSS, ensure your development environment meets the following requirements.

System Requirements​

Minimum Requirements​

RequirementMinimumRecommended
Operating SystemmacOS, Windows, or LinuxLatest stable version
RAM8 GB16 GB+
Disk Space10 GB20 GB+
ProcessorMulti-core CPUModern multi-core

Required Software​

Core Dependencies​

Node.js​

# Check Node.js version
node --version

# Required: Node.js 18.x or higher
# Recommended: Node.js 20.x (LTS)

Installation:

  • macOS: brew install node or download from nodejs.org
  • Windows: Download from nodejs.org
  • Linux: Use NodeSource repository or package manager

npm or yarn​

# npm (comes with Node.js)
npm --version

# or yarn (optional)
npm install --global yarn

Recommended: npm 10.x or higher

Database​

PostgreSQL​

# Check PostgreSQL version
psql --version

# Required: PostgreSQL 14.x or higher

Installation:

  • macOS: brew install postgresql or use PostgreSQL.app
  • Windows: Download from postgresql.org
  • Linux: sudo apt install postgresql or equivalent

Docker Alternative:

# Run PostgreSQL in Docker
docker run --name postgres \
  -e POSTGRES_PASSWORD=password \
  -p 5432:5432 \
  -d postgres:14

Redis​

# Check Redis version
redis-server --version

# Required: Redis 7.x or higher

Installation:

  • macOS: brew install redis
  • Windows: Use WSL2 or Docker
  • Linux: sudo apt install redis-server or equivalent

Docker Alternative:

# Run Redis in Docker
docker run --name redis \
  -p 6379:6379 \
  -d redis:7

Mobile Development (Optional)​

If you plan to develop the mobile app:

Expo CLI​

# Install Expo CLI globally
npm install --global @expo/cli

# Verify installation
expo --version

iOS Development (macOS only)​

  • Xcode: Download from Mac App Store
  • Required: Xcode 15.x or higher
  • iOS Simulator: Included with Xcode

Android Development​

  • Android Studio: Download from developer.android.com
  • Android SDK: Installed via Android Studio
  • Emulator: Configured in Android Studio

Version Control​

Git​

# Check Git version
git --version

# Required: Git 2.x or higher

Installation:

  • macOS: brew install git or comes with Xcode Command Line Tools
  • Windows: Download from git-scm.com
  • Linux: sudo apt install git or equivalent

Code Editors​

# Download from https://code.visualstudio.com/
# Recommended extensions:
# - ESLint
# - Prettier
# - TypeScript Hero
# - Prisma
# Check Docker version
docker --version

# Required: Docker 24.x or higher
# Required: Docker Compose 2.x or higher

Installation:

Package Managers​

npm (Default)​

# Verify npm
npm --version

# Update npm to latest
npm install --global npm@latest

yarn (Optional)​

# Install yarn
npm install --global yarn

# Verify yarn
yarn --version

Environment Setup​

Verify Your Environment​

# Check all required tools
echo "Node.js: $(node --version)"
echo "npm: $(npm --version)"
echo "Git: $(git --version)"
echo "PostgreSQL: $(psql --version 2>/dev/null || echo 'Not installed')"
echo "Redis: $(redis-server --version 2>/dev/null || echo 'Not installed')"

Example Output (macOS)​

Node.js: v20.10.0
npm: 10.2.5
Git: git version 2.39.1
PostgreSQL: psql (PostgreSQL) 14.10
Redis: Redis server v=7.2.3 sha=00000000:0 bits=64

Next Steps​

Once you have all prerequisites installed:

  1. Installation Guide - Install FSS
  2. Quick Start - Get up and running
  3. Configuration - Configure your setup

Troubleshooting​

Common Issues​

Node.js version not recognized

# Refresh your shell
source ~/.zshrc  # or ~/.bashrc

PostgreSQL connection refused

# Start PostgreSQL service
# macOS
brew services start postgresql

# Linux
sudo systemctl start postgresql

# Docker
docker start postgres

Redis not running

# Start Redis service
# macOS
brew services start redis

# Linux
sudo systemctl start redis

# Docker
docker start redis

Permission errors with npm

# Fix npm permissions
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc