This project aims to be a website and tool to share and browse blueprints for the Factorio game, with strong values in user experience to make it the least painful experience to search/filter, and create builds.

• Figma
• Issues
• Suggestions
• Pull requests
• Roadmap

The entire stack can be run in a self-contained local environment using docker-compose.

1. Set up and configure prerequisites:

   1. Required: Download Factorio game data
   2. Optional: Configure at least one external OAuth provider
   3. Optional: Configure trusted development certificates

2. Run the application

   docker-compose up --detach --build --remove-orphans

   Note: This command will pull the latest ci images from the GitHub Docker registry. If you prefer to instead build the images locally, open docker-compose.yaml, comment out the lines with image: ghcr.io/* and uncomment the blocks with image: factorio-tech/* and build: ... The same command will then build the Docker images locally.

3. Open the website in your browser of choice and take it for a spin 🚀

   • Frontend: https://local.factorio.tech
   • API: https://api.local.factorio.tech/swagger/index.html
   • Identity Provider: https://identity.local.factorio.tech/.well-known/openid-configuration

Due to licensing restrictions, we can not distribute the Factorio game assets with the source code. The game data has to be downloaded manually and made available to the application. See the volume readme for more details and instructions.

The factorio.tech application does not support logging in with username/password, but instead relies on external OAuth providers. To run the application locally, you need to configure at least one of the available providers from the table below. The callback URL must be set to https://identity.local.factorio.tech.

Once you've created an OAuth app with your provider of choice, you have to configure the local environment to use the provider: Create two configuration files that contain the client_id and the client_secret respectively for each OAuth provider you wish to configure and put them into the secrets folder. See the secrets readme for more details.

The factorio.tech application requires TLS. Out of the box, self-signed (untrusted) certificates will be used, which requires bypassing certificate validation. If you prefer, you can optionally create trusted development certificates using a tool like mkcert. Installation and setup depends on your local environment, so please follow the instructions on the website to get it up and running. Once configured, run the following command from the repository root to create the required certificates:

mkcert -cert-file .local/traefik/certs/local-cert.pem -key-file .local/traefik/certs/local-key.pem \
  "local.factorio.tech" "*.local.factorio.tech"

Traefik is configured to automatically pick up those certificates and use them instead of the self-signed one. You may need to restart traefik to apply the changes:

docker restart factorio-tech_traefik_1

This is a monorepo that contains components in different tech stacks that make up factorio builds:

• A frontend written in React/Nextjs + TypeScript
• Multiple backend services written in ASP.NET Core 5
• A Spring Boot wrapper around Factorio-FBSR that exposes a dockerised HTTP API to render blueprint images

You can find instructions on how to build and contribute to those components in the respective folders.