Installation Guide

Prerequisites

Before installing Citadel, ensure you have the following:

• Node.js 20+
• Docker and Docker Compose
• Git
• A Unix-like environment (Linux, macOS) or Windows Subsystem for Linux (WSL)

Quick Start

Follow these steps to get Citadel up and running quickly:

1. Clone the Repository

git clone https://github.com/naviNBRuas/citadel-dashboard.git
cd citadel-dashboard

2. Install Dependencies

npm install

3. Start Development Environment

docker-compose up -d

4. Run the Application

npm run dev

Production Deployment

For production deployment, please refer to our Deployment Guide.

System Requirements

Minimum Requirements

Component	Requirement
CPU	2 cores
RAM	4GB
Disk Space	10GB

Recommended Requirements

Component	Requirement
CPU	4 cores
RAM	8GB
Disk Space	50GB

Configuration

Before running Citadel, you need to configure the following:

• Environment variables (see .env.example)
• Database connection
• HashiCorp Vault integration
• Social media platform API keys

Troubleshooting

If you encounter issues during installation:

1. Ensure all prerequisites are met
2. Check the Troubleshooting Guide
3. Review logs in the logs/ directory
4. Open an issue on GitHub if the problem persists

Support

For installation assistance, please refer to our Support Guide.