Astra

A constellation of micro-services to power Archon + Aspira and Connect to Aevus

✨ Features

• Docker Compose - Deploy with a single command.
• Unreal Engine 5.6 - Dedicated Server with Remote Control API
• LoopBack API with GraphQL- Develop your Backend Game API
• Prometheus - Real-time Monitoring of all services
• TypeScript - Full type safety and better developer experience
• pnpm - Performant package management focused on minimal package size and resources
• Node - a cross-platform, open-source JavaScript runtime environment.
• PostgreSQL with GraphQL - flexible and modular authentication middleware.
• ESLint, Prettier, Husky and Lint-Staged - Automated Code Quality and Beautification.

📚 Containers

• Unreal Engine Dedicated Server - with Node.js and Remote Control API.
• Loopback API - Develop your Backend Game API
• Game PostgreSQL Database - Full type safety and better developer experience
• Archon - Powerful data fetching and state management
• Archon PostgreSQL Database - Beautiful and accessible UI components
• Aevus Public API - Modern utility-first CSS framework
• Prometheus - Real-time Monitoring of all services

🚀 Quick Start

Before You Start

You will need to have the following Keys and Secrets available for the setup process.

Admin account passwords and Database Credentials will be Autogenerated at Setup.

Aevus API Key
Prometheus API Key
OAuth2 API Key, Secret and Endpoint URLs for each Provider you wish to use
HMAC Key 1
HMAC Secret 1

You have two options to provide Keys and Secrets

1. Interactive Input

2. Premade .env File

DB_DRIVER=postgresql
DB_HOST=localhost
DB_PORT=5432
DB_USER=your_user
DB_PASSWORD=your_password
DB_NAME=your_database_name

Run Setup Script

   ./Astra-Setup.sh

Follow the on screen prompts. First your HMAC secrets, followed by API keys.

If an .env file is detected, this section will be skipped.

Setup will then start the containers in the following order

Databases->Backends->Frontends

Open your browser

http://localhost:5173

📁 Project Structure

Dockerfile
Astra-Setup.sh
Astra-Setup.bat
client/
├──src/
    ├── components/         # Reusable UI components
    │   ├── app-sidebar/    # Sidebar navigation components
    │   └── ui/             # shadcn/ui components
    ├── hooks/              # Custom React hooks
    ├── lib/                # Utility functions and configs
    ├── routes/             # Route components and layouts
    └── styles/             # Global styles and CSS
server/
├──src/
    ├── routes/             # API Routes

🔧 Available Scripts

• ./Astra-Setup.sh - Setup Script

📄 License

This project is open source and available under the MIT License.