Skip to content

Configuration Files Overview

settings

This system relies on two primary configuration files for customization:

Configuration Required

Before proceeding, ensure you've copied these critical files:

  • 📄 backend/config.template.js → backend/config.js
  • 🔧 .env.template → .env

Failure to do this will cause application errors.

  1. config.js

    • Contains all non-sensitive application settings with detailed, in-line documentation.
    • Ideal for configuring general application behavior and features.

  2. .env

    • Stores sensitive credentials and environment-specific variables.
    • Should always be included in .gitignore to prevent accidental commits to version control.

Best Practices:

  • Utilize config.js for non-sensitive, general application settings.
  • Store secrets and environment-specific variables exclusively in .env.
  • Consult the documentation comments within config.js for detailed configuration guidance.
  • Secure the .env file by restricting access and including it in .gitignore.