/evemapper

Eve Mapper is a signature logging, route planner and solar system mapping tool in the Eve Online game.

Primary LanguagePHPMIT LicenseMIT

SWUbanner

GitHub GitHub top language GitHub language count GitHub last commit

EveMapper

EveMapper is a signature logging, route planner and solar system mapping tool in the Eve Online game.

Requirements

Common:

  • PHP 8+
  • Nginx

PHP extensions:

  • php-mbstring
  • php-sqlite3
  • php-exif
  • php-pcntl
  • php-bcmath
  • php-gd

See /install for docker-compose and nginx configuration files.

Installation

  1. Clone repository.
git clone https://github.com/ruslandem/evemapper
  1. Correct permissions and make initial config:
sudo chown -R www-data:www-data evemapper
cd evemapper
php -r "file_exists('.env') || copy('.env.example', '.env');"
php -r "file_exists('./resources/assets/js/config.ts') || copy('./resources/assets/js/config.example.ts', './resources/assets/js/config.ts');"
  1. Install depencies:

Composer and npm (for production):

composer install --no-dev --optimize-autoloader --quiet
npm install --quiet --no-progress --omit=dev
npm run build

Generate application key:

php artisan key:generate
  1. Compose database (--force required when running in production mode):
php artisan migrate:install
php artisan migrate --force
  1. Start micro-services by following the procedure in docker-compose.xml.
docker compose up -d --build
  1. Configuration.
  • Add your Eve Online developer ID and KEY in file .env
  • Add (optionally) your character nickname to admins list in files .env and resourses/assets/js/config.ts

(changing the config.ts requires running a new build npm run build)

See comments in the configuration files for other options.

Testing

Test environment should use another database (i.e. app_test.db) in the same directory.

Prior testing, please create separate environment file:

cp .env .env.testing

and change the next parameters:

...
APP_ENV=testing
DB_APP=app_test.db
...

After you have created the testin environment file as specified above, you can install and run testing database migration:

touch database/app.db
php artisan migrate:install --env=testing
php artisan migrate --env=testing

Finally, you can rpoceed to the testing:

php artisan test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT © Ruslan Demchenko