README.MD

Table of Contents

• Intro
  • Planned Features
• F3M
  • Project Structure
  • Prerequisites
  • Getting Started
    • Run locally
    • Run with Docker Compose
  • Building for Production
• Contributing

---

Intro

Flander's Manaka Mod Manager is a Website for hosting mods for any game.

Planned Features

• User registration/login
• Mod upload/download
• Mod versioning
• Mod dependencies
• Markdown for mod descriptions
• Mod packs
• User profiles
• A Desktop application working in tandem with this project [Big project]

F3M

F3M is a full-stack web application built with Blazor WebAssembly on .NET 10. It follows the standard Blazor Hosted architecture, splitting responsibilities across three projects: a browser-side Blazor client, an ASP.NET Core server, and a shared class library for common models and contracts.

Layer	Technology
Frontend	Blazor WebAssembly (C#, HTML, CSS)
Backend	ASP.NET Core Web API
Shared	.NET Class Library
Runtime	.NET 10
Containerization	Docker / Docker Compose

---

Project Structure

F3M/
├── F3M.Client/       # Blazor WebAssembly frontend
├── F3M.Server/       # ASP.NET Core backend (hosts the client + API)
├── F3M.Shared/       # Shared models, DTOs, and contracts
├── Dockerfile        # Multi-stage Docker build (Alpine-based)
├── compose.yaml      # Docker Compose configuration
├── F3M.sln           # Visual Studio solution file
└── global.json       # .NET SDK version pin (10.0, latestMinor)

---

Prerequisites

• .NET 10 SDK (preview or stable)
• Docker (optional, for containerized deployment)

---

Getting Started

Run locally

git clone https://github.com/FlanderDev/F3M.git
cd F3M

dotnet restore
dotnet run --project F3M.Server

The application will be available at https://localhost:5001 (or the port configured in launchSettings.json).

Run with Docker Compose

docker compose up --build

The server will be exposed on:

• http://localhost:8081 → container port 8080
• https://localhost:443

---

Building for Production

dotnet publish F3M.Server -c Release -o ./publish

Or build and push a Docker image:

docker build -t f3m .

The Dockerfile uses a multi-stage Alpine build targeting the server project. The final image is based on mcr.microsoft.com/dotnet/aspnet:10.0-alpine and runs F3M.Server.dll as the entrypoint.

---

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/my-feature)
3. Commit your changes (git commit -m 'Add my feature')
4. Push to the branch (git push origin feature/my-feature)
5. Open a Pull Request