-
Notifications
You must be signed in to change notification settings - Fork 33
Expand file tree
/
Copy path.env.example
More file actions
55 lines (53 loc) · 1.95 KB
/
Copy path.env.example
File metadata and controls
55 lines (53 loc) · 1.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# ============================================
# VertexChain Root Environment Configuration
# ============================================
#
# This file documents shared environment variables used across multiple workspaces.
# Each workspace (Backend, Frontend, Analytics) has its own .env.example file
# with workspace-specific configuration.
#
# Please refer to the individual workspace .env.example files:
# - Backend/.env.example - API server configuration
# - Frontend/.env.example - Main frontend application
# - analytics/.env.example - Analytics dashboard
#
# ============================================
# Shared Configuration
# ============================================
# NODE_ENV (optional)
# Application environment mode used across all Node.js workspaces
# Values: development | production | test
# Default: development
NODE_ENV=development
# ============================================
# Setup Instructions
# ============================================
#
# 1. Make sure you have Node.js 20 installed (use nvm: `nvm use`)
# 2. Copy this file and workspace-specific .env.example files to .env:
# - cp Backend/.env.example Backend/.env
# - cp Frontend/.env.example Frontend/.env
# - cp analytics/.env.example analytics/.env
# 3. Update each .env file with your actual configuration values
# 4. Install dependencies in each workspace:
# - cd Backend && npm install
# - cd Frontend && npm install
# - cd analytics && npm install
# 5. Start the development servers (see CONTRIBUTING.md for details)
#
# ============================================
# Quick Reference - Required Services
# ============================================
#
# Backend requires:
# - PostgreSQL database (local or remote)
# - Stellar/Soroban RPC endpoint (testnet/mainnet)
# - (Optional) Pinata account for IPFS pinning
#
# Frontend requires:
# - Backend API server running
#
# Analytics requires:
# - Mapbox account and access token
# - (Optional) Backend API server for live data
#