idmarinas/lotgd-skeleton

A new version of The Legend of the Green Dragon, upgrade scripts and optimization , migrating to a Symfony Application


Keywords
gulp, composer, skeleton, skeleton-application, lotgd, lotgd-idmarinas-edition
License
CC-BY-NC-SA-2.0

Documentation

GitHub release GitHub Release Date GitHub code size in bytes Website Build in PHP

GitHub issues GitHub pull requests Github commits (since latest release) GitHub commit activity GitHub last commit

GitHub top language GitHub language count

Maintainability Code Climate technical debt

built with gulp built with webpack Dependabot Status

PayPal.Me - The safer, easier way to pay online! Liberapay - Donate Twitter

About

This is the template for the IDMarinas Edition core. It contains what you need to create your customization and tools to build it. This skeleton does not include the core files, they are not necessary for the creation of your customization.

IDMarinas Edition

Skeleton version for IDMarinas Edition: 6.0.*

First steps

  • You need have installed npm, composer and gulp as global commands.

    Gulp globally, run command npm install gulp-cli -g Composer globally see https://getcomposer.org/download/

Create project

Method 1

  • Run command composer create-project idmarinas/lotgd-skeleton MyCustomLoTGD to create a skeleton of LoTGD Core

    It will create a MyCustomLoTGD directory with a new LoTGD Core application inside.

  • Run command npm install for install all nodes packages.
    • Note: When Fomantic Ui asks you to install, select "Skip install" and then accept everything.
    • Not is necesary install in proyect folder.

Method 2

  • Clone repository in your directory.
  • Run command composer install for install all composer packages.
  • Run command composer lotgd:skeleton:project:create
    • This copy files to _core_files/ folder for you.
    • Olso copy files needed for commands in your MyCustomLoTGD directory.
  • Run command php bin/console lotgd:regenerate:app_secret this regenerate APP_SECRET of .env file.
    • Only need run one time.
  • Run command php bin/console lotgd:regenerate:app_secret --iv this regenerate APP_SECRET_IV of .env file.
    • Only need run one time.
  • Run command npm install for install all nodes packages.
    • Note: When Fomantic Ui asks you to install, select "Skip install" and then accept everything.
    • Not is necesary install in proyect dir.

Upgrade project from previous version (New in version 5.2.* of Skeleton)

  • Before make any change, commit all changes in your project.
    • With this can see all new changes can modify as you need.

For project of version 5.1.* and lower.

  • Need download repository and copy files to your project directory.
    • Revise all changes and make changes as you need.
  • Run command composer lotgd:skeleton:project:upgrade and wait.

For project of version 5.2.* and higher.

  • In your composer.json search the following packages:
    • "idmarinas/lotgd" and "idmarinas/lotgd-skeleton" Upgrade the version of these packages to the desired version, e.g. 5.2.*
    • Both packages must have the same major version and the same minor version, the patch version must always be an asterisk.
      • Note: X.Y.Z: X is a major version, Y is a minor version, Z is a patch version.
      • Note: with * in patch version this download los patches of packages this is only a fixed errors, not break your installation.
  • Run command composer update
  • Wait to finish.
  • Run command composer lotgd:skeleton:project:upgrade and wait.

Prepare your custom LoTGD

  • Configure .env file with your data.
    • Can create multiple files for separate config for enviroment:
      • .env.prod contain data for production environment.
      • .env.dev contain data for development environment.
      • .env.test contain data for test environment.
    • Can read comments in .env for know how work .env files.
  • Run command php bin/console lotgd:regenerate:app_secret this regenerate APP_SECRET of .env file.
    • ⚠️ Only need first time install LoTGD. If you already have a project in production, changing it again may break your installation.
  • Run command php bin/console lotgd:regenerate:app_secret -iv this regenerate APP_SECRET_IV of .env file.
    • ⚠️ Only need first time install LoTGD. If you already have a project in production, changing it again will cause all previously encrypted data to become unencryptable.
  • Now only need prepare all your customizations and modules

Prepare for deployment

  • Run command npm run lotgd-dev for build a version for development server, located in dist/dev/
  • Run command npm run lotgd-prod for build a version for production server, located in dist/prod/

Tips

  • Composer and Package
    • You can add new dependencies as your project needs them, but do NOT remove any of the default ones.
    • Note: Please do not change the versions of the dependencies.

Other

Read Wiki for more information.