AA Blueprint Forge

A Blueprint Forge App for Alliance Auth

• AA Blueprint Forge
  • Features
  • Highlights
  • Installation
    • Step 1 - Install the Package
    • Step 2 - Configure Alliance Auth
    • Step 3 - Add the Scheduled Tasks
    • Step 3.1 - (Optional) Add own Logger File
    • Step 4 - Migrate & Preload EVE SDE Data
    • Step 4.1 - Migrate App and collect static
    • Step 5 - Setting up Permissions
    • Step 6 - (Optional) Setting up Compatibilies
  • Frontend Development (React SPA)
    • Tech Stack
    • Frontend Makefile Commands
    • Local Frontend Development
  • Translations
  • Contributing

Features

Highlights

Installation

Step 1 - Install the Package

Make sure you're in your virtual environment (venv) of your Alliance Auth then install the pakage.

pip install aa-blueprint-forge

Step 2 - Configure Alliance Auth

Configure your Alliance Auth settings (local.py) as follows:

INSTALLED_APPS = [
    # other apps
    "eve_sde",  # only if it not already existing
    "bpforge",
    # other apps?
]

# This line is right below the `INSTALLED_APPS` list, if not already exist!
INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

To set up the Scheduled Tasks add following code to your local.py

if "bpforge" in INSTALLED_APPS:
    CELERYBEAT_SCHEDULE["AA Blueprint Forge :: Update Blueprints"] = {
        "task": "bpforge.tasks.update_all_blueprints",
        "schedule": 600,
    }

Step 3.1 - (Optional) Add own Logger File

To set up the Logger add following code to your local.py Ensure that you have writing permission in logs folder.

LOGGING["handlers"]["bpforge_file"] = {
    "level": "INFO",
    "class": "logging.handlers.RotatingFileHandler",
    "filename": os.path.join(BASE_DIR, "log/bpforge.log"),
    "formatter": "verbose",
    "maxBytes": 1024 * 1024 * 5,
    "backupCount": 5,
}
LOGGING["loggers"]["extensions.bpforge"] = {
    "handlers": ["bpforge_file"],
    "level": "DEBUG",
}

Step 4 - Migrate & Preload EVE SDE Data

AA Blueprint Forge uses EVE SDE data to map IDs to names for EveTypes. You will need to preload some data from SDE once.

python manage.py migrate eve_sde
python manage.py esde_load_sde

Step 4.1 - Migrate App and collect static

Migrate the app and collect static.

python manage.py migrate bpforge
python manage.py collectstatic --noinput

Step 5 - Setting up Permissions

With the Following IDs you can set up the permissions for Blueprint Forge

Step 6 - (Optional) Setting up Compatibilies

The Following Settings can be setting up in the local.py

• BPFORGE_APP_NAME: "YOURNAME" - Set the name of the APP
• BPFORGE_TASKS_TIME_LIMIT: 7200 - Defines the time (in seconds) a task will timeout

If you set up BPFORGE_LOGGER_USE to True you need to add the following code below:

Frontend Development (React SPA)

The user interface of AA Blueprint Forge is built as a modern React Single-Page Application (SPA) located in the frontend/ directory.

Tech Stack

• Framework: React 19, TypeScript
• Bundler & Tooling: Vite 8 (@vitejs/plugin-react-swc), AllianceAuth styles from frontend/src/index.css
• UI Components & Icons: React-Bootstrap, Lucide Icons (lucide-react)
• Data & Tables: TanStack React Query (@tanstack/react-query), TanStack Table (@tanstack/react-table)
• API Client: openapi-fetch with types generated via openapi-typescript
• Testing: Vitest with @testing-library/react and jsdom
• Localization: i18next & react-i18next (12 languages)

Frontend Makefile Commands

You can control the frontend build, test, and development workflows directly from the repository root:

Local Frontend Development

1. Install dependencies:

   cd frontend
   npm install
   

2. Start Vite development server:

   # Inside frontend/
   npm run dev
   
   # Or from repository root:
   make react-dev
   

3. Run tests and linter:

   make react-test
   make react-lint
   

Translations

Help us translate this app into your language or improve existing translations. Join our team!"

Contributing

You want to improve the project? Please ensure you read the Contribution Guidelines