MR Project Init Package

Setup Guide

1. To download, npm i -g @moustacherepublic/mr-init-project@latest

2. Run mri to instantly start up your local if you already have your local credentials and config file set up

3. For fresh local setup, use mri -fs

4. You are also able to pass in the various flags:

   • Common Flags (assume node_modules already present):

     • -d|--dev : fetches DEVELOPMENT credentials only

     • -p|--prod : fetches PRODUCTION credentials only

     • -sd|--start-dev : fetches DEVELOPMENT credentials and starts up local only

     • -sp|--start-prod : fetches PRODUCTION credentials and starts up local only

   • Useful Flags:

     • -h|--help : show help.

     • -fs|--full-setup : full setup with fresh node_modules and config file

     • -ip|--install-prod : full setup with fresh node_modules and PRODUCTION credentials

     • -id|--install-dev : full setup with fresh node_modules and DEVELOPMENT credentials

     • -u|--update : updates this package to latest

   • Other Flags:

     • -is|--install-skip : installs node modules only

     • -a|--append-script : takes in 2 other arguments (1st is the script to be added, 2nd is the script of this global package which the 1st will be added to)

To-do

1. Add profiles handler to handle more than 1 presets based on various projects.

Misc

1. NPM Package: https://www.npmjs.com/package/@moustacherepublic/mr-init-project

2. Repo: https://bitbucket.org/moustacherepublic/mr-project-init-package/src/master/

3. Feedback: https://magikecommerce.atlassian.net/browse/MRIP-908

   • Please change status to "PENDING" if adding new feedback.

Changelog

v0.6.0 - v0.6.14 - 23 Apr 2021

1. Updated script logic to load files if not present when not using any flags.

2. Updated config format and parsing logic.

3. Implemented logic to recognise existing env files when not using any flags.

4. Implemented help commands and added help flags.

5. Updated husky pre-commit to only add package.json instead of all files.

v0.5.0 - v0.5.8 - 20 Apr 2021

1. Changed up flags functionalities and added new flag -fs -u.

2. Updated config filename to be dynamic.

3. Updated script logic to accommodate flags update.

4. Shortened command for script.

5. Added husky hooks.

6. Removed unnecessary file and packages.

7. Fixed json file format.

8. Set default to be staging_config.

v0.1.0 to v0.4.4 - 19 Apr 2021

1. Set up package.

2. Implemented script to init and process project variables.

3. Added ascii art.

4. Updated script for flag commands.

5. Updated script to edit .gitignore if not already updated.

6. Fixed colour encodings in script.

7. Added append-script flag.

8. Separated out install-and-updated-modules into a separate script for advanced script editing.

9. Added global package paths as variables.

10. Migrated package from @kaikoh95 to @moustacherepublic.

11. Fixed script error for -is and -a flags.

12. Updated command to remove node_modules that was causing override error.

13. Added CircleCI, npmignore.

14. Added script to update package version automatically.

15. Installed request and fs modules.