🚜 FS25 Farm Management System

A comprehensive farm management web application for Farming Simulator 25 players

Track fields, livestock, equipment, and finances with a realistic British farming dashboard

Features • Quick Start • Development • Deployment

✨ Features

FS25 Farm Managment System

Track crop growth stages, fertiliser application, and weed states
Visual field cards with status indicators Access the app: http://localhost:3000

🔄 Crop Rotation Planner

Intelligent 4-year rotation suggestions based on UK farming best practices
Prevents disease buildup and optimizes soil health
Season-specific planting recommendations

💰 Financial Ledger

Complete income/expense tracking with real-time balance calculations
Category-based organization (Sales, Purchases, Equipment, etc.)

🐄 Livestock Management

Track animal counts by type (Cows, Sheep, Chickens, Pigs)
Monitor feed requirements and productivity

🚜 Equipment Registry

Machinery tracking with ownership status (owned/leased)
Daily cost calculations and condition monitoring

👥 Multi-User Collaboration

Role-based access control (Owner, Editor, Viewer)
Time-limited join codes for farm invitations

🚀 Quick Start

Prerequisites

Node.js 20.x or higher (Download)
Git (Download)

Installation

# Clone the repository (correct repo name)
git clone https://github.com/Callum-Mason/FS25-Farm-Managment-System.git
cd FS25-Farm-Managment-System

# Install dependencies
npm install

# Create environment file (PowerShell)
Copy-Item .env.example .env
# On macOS / Linux use: cp .env.example .env

# Start the development server
npm run dev

Access the app: http://localhost:3000

Demo Account

Email: demo@farm.local
Password: Demo1234!

Docker (Docker Compose)

You can build and run the whole application with Docker Compose. By default the app uses the bundled SQLite database (persisted to ./data), but you can switch to the included PostgreSQL service by setting the appropriate env vars.

PowerShell (from project root):

# Build images (uses Dockerfile in repo root)
docker compose build

# Start services (foreground)
docker compose up

# Start services detached
docker compose up -d

# Stop and remove containers
docker compose down

Notes:

The server will be available at: http://localhost:3000
If you want to use the bundled Postgres service, copy .env.sample to .env and set:

DB_HOST=db
DB_USER=farm
DB_PASSWORD=farm_pass
DB_NAME=farm_manager

By default the app uses SQLite (no extra config). The SQLite DB file is stored in ./data on the host (this folder is mounted into the container by the Compose file).
To follow logs for the app service:

docker compose logs -f app

💻 Development Setup

Project Structure

FS25-Farm-Managment-System/
├── server/                 # Backend (Node.js + Express)
│   ├── routes/            # API endpoints
│   ├── middleware/        # Auth & permissions
│   └── database/          # Database adapters & migrations
├── src/                    # Frontend (Vue 3 + TypeScript)
│   ├── components/        # Reusable Vue components
│   ├── views/             # Page components
│   ├── stores/            # Pinia state management
│   └── router/            # Vue Router config
└── tests/                  # Test suites

Available Scripts

# Development
npm run dev              # Start dev server with hot reload

# Database
npm run migrate          # Run database migrations (auto-detects SQLite/PostgreSQL)

# Building
npm run build            # Build frontend and backend for production
npm run build:frontend   # Build Vue.js frontend only
npm run build:backend    # Compile TypeScript backend only

# Production
npm start                # Run production build

# Testing
npm test                 # Run all tests
npm run test:watch       # Run tests in watch mode
npm run test:api         # Run API tests (test:api)

Database Setup

The project uses a unified migration system that works with both SQLite (local) and PostgreSQL (production):

# Run migrations (auto-detects database type)
npm run migrate

# Or run directly
node server/database/migrate.cjs

What it does:
✅ Creates all tables (users, farms, fields, animals, equipment, finances, etc.)
✅ Sets up indexes for performance
✅ Creates triggers and helper functions
✅ Tracks applied migrations to prevent duplicates
✅ Safe to run multiple times (idempotent)

For detailed migration documentation, see MIGRATION_GUIDE.md.

Environment Variables

Create a .env file in the project root:

# Server Configuration
PORT=3000
NODE_ENV=development

# Authentication
JWT_SECRET=your-random-secret-key-min-32-characters

# Database (SQLite for local development)
DB_FILE=./data/farm_manager.db

# For PostgreSQL (optional local testing)
# DB_HOST=localhost
# DB_PORT=5432
# DB_NAME=farmmanager
# DB_USER=postgres
# DB_PASSWORD=your-password

Local Development Features

Hot Module Replacement (HMR) - Instant updates without refresh
SQLite Database - Zero-config local database
TypeScript - Full type safety
Demo Data - Pre-seeded with sample farm data

☁️ Azure Deployment with GitHub Actions

Overview

Deploy your Farm Management System to Azure with automated CI/CD using GitHub Actions. The application will run on:

Azure App Service (B1 tier) - ~£40/month
Azure PostgreSQL Flexible Server (B1ms tier) - ~£10/month
Total cost: ~£50/month

Azure prerequisites

Azure Account - Create free account
Azure CLI - Install via:
```
winget install Microsoft.AzureCLI
```
GitHub Account - Your repository must be on GitHub

Step 1: Deploy Azure Infrastructure

# Login to Azure
az login

# Set your subscription (if you have multiple)
az account set --subscription "Your-Subscription-Name"

# Clone and navigate to repository
git clone https://github.com/Callum-Mason/FS25-Farm-Managment-System.git
cd FS25-Farm-Managment-System

# Install dependencies
npm install

# Run deployment script
.\deploy-infrastructure.ps1

The deployment script will:

✅ Create Azure resource group
✅ Provision PostgreSQL Flexible Server
✅ Set up App Service with Node.js 20
✅ Configure environment variables
✅ Run database migrations

Note: You'll be prompted for a PostgreSQL admin password. Save this securely!

Step 2: Configure GitHub Secrets

Your GitHub Actions workflow needs two pieces of information:

2a. Set GitHub Variable

Go to your repository on GitHub
Navigate to Settings → Secrets and variables → Actions
Click the Variables tab
Click New repository variable
Add:
- Name: AZURE_WEBAPP_NAME
- Value: Your Azure Web App name (e.g., fs25fms-app-xxxxx)

2b. Set GitHub Secret

Get your publish profile:

az webapp deployment list-publishing-profiles `
  --name YOUR-AZURE-APP-NAME `
  --resource-group YOUR-RESOURCE-GROUP `
  --xml > publish-profile.xml

In GitHub, go to Settings → Secrets and variables → Actions
Click the Secrets tab
Click New repository secret
Add:
- Name: AZURE_WEBAPP_PUBLISH_PROFILE
- Value: Paste the entire contents of publish-profile.xml
Important: Delete the local publish-profile.xml file:
```
Remove-Item publish-profile.xml
```

Step 3: Deploy with GitHub Actions

# Commit your changes (if any)
git add .
git commit -m "Configure deployment"

# Push to GitHub - this triggers deployment
git push origin main

Step 4: Monitor Deployment

Go to your repository's Actions tab on GitHub
Watch the "Deploy to Azure" workflow run
Deployment typically takes 3-5 minutes

Once complete, your app will be live at: https://YOUR-AZURE-APP-NAME.azurewebsites.net

Automatic Deployments

Every time you push to the main branch, GitHub Actions will:

✅ Install dependencies
✅ Build frontend (Vite)
✅ Compile TypeScript backend
✅ Deploy to Azure App Service
✅ Your app updates automatically

Troubleshooting Deployment

Check application logs:

az webapp log tail --name YOUR-AZURE-APP-NAME --resource-group YOUR-RESOURCE-GROUP

Restart the app:

az webapp restart --name YOUR-AZURE-APP-NAME --resource-group YOUR-RESOURCE-GROUP

Verify environment variables:

az webapp config appsettings list `
  --name YOUR-AZURE-APP-NAME `
  --resource-group YOUR-RESOURCE-GROUP `
  --output table

🛠️ Tech Stack

Backend

Node.js 20 LTS - Runtime environment
Express.js - Web framework
PostgreSQL / SQLite - Dual database support
JWT + bcrypt - Authentication

Frontend

Vue 3 - Progressive JavaScript framework
TypeScript - Type safety
Pinia - State management
Vue Router - Navigation
Tailwind CSS - Utility-first styling
Vite - Build tool

DevOps

GitHub Actions - CI/CD pipeline
Azure App Service - Hosting (Linux)
Azure PostgreSQL - Production database
Azure Key Vault - Secrets management

📖 API Documentation

Authentication Endpoints

POST /api/auth/register    # Create new account
POST /api/auth/login       # Login and get JWT token

Farm Management

GET    /api/farms                    # List your farms
POST   /api/farms                    # Create new farm
GET    /api/farms/:farmId            # Get farm details
PATCH  /api/farms/:farmId            # Update farm
DELETE /api/farms/:farmId            # Delete farm (owner only)

Field Tracking

GET    /api/farms/:farmId/fields     # List fields
POST   /api/farms/:farmId/fields     # Create field
PATCH  /api/fields/:farmId/:id       # Update field
DELETE /api/fields/:farmId/:id       # Delete field

Financial Ledger

GET    /api/farms/:farmId/finances   # Get transactions + balance
POST   /api/farms/:farmId/finances   # Add transaction
DELETE /api/finances/:farmId/:id     # Delete transaction

All endpoints (except auth) require:

Authorization: Bearer <jwt-token>

🔒 Security Features

✅ Password Hashing - bcrypt with 10 rounds
✅ JWT Authentication - 7-day token expiry
✅ Role-Based Access - Owner, Editor, Viewer permissions
✅ SQL Injection Protection - Parameterized queries
✅ HTTPS Enforced - In production
✅ Environment Variables - Never commit secrets

🧪 Testing

# Run all tests
npm test

# Run with coverage
npm run test:coverage

# Watch mode during development
npm run test:watch

Test Coverage:

✅ API endpoint tests
✅ Authentication & authorization
✅ Database operations
✅ Vue component tests

🤝 Contributing

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Make your changes and add tests
Run tests: npm test
Commit: git commit -m 'Add amazing feature'
Push: git push origin feature/amazing-feature
Open a Pull Request

📄 License

This project is provided as-is for personal use.

🙏 Acknowledgments

Built for the Farming Simulator 25 community with ❤️

🚜 Happy Farming! 🌾

⬆ Back to Top

Name		Name	Last commit message	Last commit date
Latest commit History 29 Commits
.github/workflows		.github/workflows
.vscode		.vscode
server		server
src		src
tests		tests
.dockerignore		.dockerignore
.env.example		.env.example
.gitignore		.gitignore
API_INTEGRATION_DOCS.md		API_INTEGRATION_DOCS.md
Dockerfile		Dockerfile
INFRASTRUCTURE_DEPLOYMENT.md		INFRASTRUCTURE_DEPLOYMENT.md
MIGRATION_GUIDE.md		MIGRATION_GUIDE.md
QUICK_START_IMPORT.md		QUICK_START_IMPORT.md
README.md		README.md
deploy-infrastructure.ps1		deploy-infrastructure.ps1
docker-compose.yml		docker-compose.yml
index.html		index.html
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js
tailwind.config.js		tailwind.config.js
tsconfig.json		tsconfig.json
tsconfig.server.json		tsconfig.server.json
vite.config.ts		vite.config.ts

Folders and files

Latest commit

History

Repository files navigation