Skip to content

Development

Jump to bottom
Peter J McDade edited this page Feb 2, 2026 · 2 revisions

🔧 Development

For those who want to expand the factory and contribute blueprints!

🏗️ Architecture

The backend is a Go REST API that also serves the React frontend.

Route Description
/ 🌐 Frontend application
/api/* ⚙️ REST API endpoints
/ws 📡 WebSocket for real-time updates

🔐 API Authentication

Before accessing the API, you need to authenticate (like inserting a keycard):

# Login and save cookie
curl --cookie-jar cookie.txt --insecure \
  --data '{"username":"admin","password":"factorio"}' \
  -H "Content-Type: application/json" \
  -X POST https://localhost/api/login

# Use the cookie for subsequent requests
curl --cookie cookie.txt --insecure https://localhost/api/server/status

📦 Requirements

Tool Version
🐹 Go 1.11+
📦 NodeJS 10.13.0+

🚀 Building Releases

Create release zips for Windows and Linux:

git clone git@github.com:petejm/factorio-server-manager.git
cd factorio-server-manager
make gen_release

This produces:

  • build/factorio-server-manager-linux.zip
  • build/factorio-server-manager-windows.zip

🔨 Building for Development

Quick build for testing:

git clone git@github.com:petejm/factorio-server-manager.git
cd factorio-server-manager
make
./factorio-server-manager/factorio-server-manager --dir /path/to/factorio

⚛️ Frontend Development

The frontend uses React with Webpack.

Build Commands

Command Description
npm run dev 🔧 Development build with source maps
npm run watch 👀 Auto-rebuild on file changes
npm run hot 🔥 Hot reload (in theory)
npm run build 📦 Production build (minified)

Quick Start

cd factorio-server-manager
npm install
npm run watch  # In one terminal

# In another terminal, run the Go server
cd src && go run . --dir /path/to/factorio

Output files:

  • app/bundle.js — Transpiled JavaScript
  • app/style.css — Compiled styles

🪟 Building for Windows

  1. 📥 Download and unzip the source code

  2. 📦 Install requirements:

  3. 🔨 Build the backend:

    cd factorio-server-manager\src
go build

  4. 🎨 Build the frontend:

    cd factorio-server-manager
npm install
npm run build

  5. 🚀 Run:

    .\src.exe --dir C:\path\to\Factorio

  6. 🌐 Visit localhost:8080

📁 Project Structure

factorio-server-manager/
├── app/                    # 🌐 Built frontend assets
├── docker/                 # 🐳 Docker configurations
├── src/                    # 🐹 Go backend source
│   ├── api/               # REST API handlers
│   ├── bootstrap/         # Configuration & startup
│   └── factorio/          # Factorio server control
├── ui/                     # ⚛️ React frontend source
│   ├── App/               # React components
│   └── api/               # API client
├── Makefile               # 🔨 Build automation
└── conf.json              # ⚙️ Default configuration

🤝 Contributing

  1. 🍴 Fork the repository
  2. 🌿 Create a feature branch
  3. 💻 Make your changes
  4. ✅ Test thoroughly
  5. 📬 Submit a pull request

The factory always has room for more engineers! 👷

Clone this wiki locally