An opensource airline game.

Forked from https://www.airline-club.com/ Live at https://myfly.club/

Dependencies

• Java openjdk 17
• MySQL 8
• Sbt

Setup

1. Create MySQL database matching values defined here.
2. Maps are built using Protomaps. https://protomaps.com/
3. For a small private game, you can probably use their dev host for free. Create a key and update web application.conf protomaps.apiKey
4. Or, we can probably host the map for you – reach out!
5. Or, follow the protomaps.com instructions to setup your own Cloudflare R2 solution.
6. For airport images, you will need a Google Places API key. Create one and update the web application.conf google.apiKey
7. Now let's run the app! Navigate to airline-data and run sbt publishLocal.
8. In airline-data, run sbt run,
   1. Then, choose #1 i.e. MainInit. It will take awhile to build the game universe.
9. Open another terminal, navigate to airline-web, run the web server by sbt run
10. The application should be accessible at localhost:9000

Alternate Docker Setup

This hasn't been update in awhile

1. Install Docker & Docker-compose
2. run cp docker-compose.override.yaml.dist docker-compose.override.yaml and then edit the new file with your preferred ports. Mysql only has to have exposed ports if you like to connect from outside docker
   1. If you plan to use this anything else than for development, adjust the credentials via environment variables
3. start the stack with docker compose up -d and confirm both containers are running
4. open a shell inside the container via docker compose exec airline-app bash
5. run the init scripts:
   1. sh init-data.sh (might need to run it a couple of times because migration seems to be spotty)
6. To boot up both front and backend, use the start scripts sh start-data.sh and sh start-web.sh in separate sessions
7. The application should be accessible at your hosts ip address and port 9000. If docker networks aren't limited by firewalls or network settings, it should be available without any reverse-proxying. (Dev only!)

Nginx Proxy w/ Cloudflare HTTPS

In Cloudflare go to your domain and then SSL/TLS > Origin Server. Click Create Certificate > Generate private key and CSR with Cloudflare > Drop down choose ECC > Create

Save your Origin Certificate and your Private Key to a file. Example:

Orgin Certificate: domain.com.crt

Private Key: domain.com.key

Example nginx virtualhost conf file:

server {

  listen 443 ssl http2;
  listen [::] ssl http2;
  server_name domain.com;

  ssl_certificate      /usr/local/nginx/conf/ssl/domain.com/domain.com.crt;
  ssl_certificate_key  /usr/local/nginx/conf/ssl/domain.com/domain.com.key;

  add_header X-Frame-Options SAMEORIGIN;
  add_header X-Xss-Protection "1; mode=block" always;
  add_header X-Content-Type-Options "nosniff" always;
  add_header Referrer-Policy "strict-origin-when-cross-origin";

  access_log /home/nginx/domains/domain.com/log/access.log combined buffer=256k flush=5m;
  error_log /home/nginx/domains/domain.com/log/error.log;

  location /assets  {
    alias    /home/airline/airline-web/public/;
    access_log on;
    expires 30d;
  }

  location / {
    proxy_pass http://localhost:9000;
    proxy_pass_header Content-Type;
    proxy_read_timeout     60;
    proxy_connect_timeout  60;
    proxy_redirect         off;

    # Allow the use of websockets
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection 'upgrade';
    proxy_set_header Host $host;
    proxy_cache_bypass $http_upgrade;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  }

}

Attribution

1. Some icons by Yusuke Kamiyamane. Licensed under a Creative Commons Attribution 3.0 License