backups/Fantasy-Map-Generator
1
0
Fork 0
mirror of https://github.com/Azgaar/Fantasy-Map-Generator.git synced 2025-12-22 03:51:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

break up script into 4 smaller refactor scripts preparing it to be ported to modular library leveraing vuejs

Browse source
This commit is contained in:
headwinds 2018-10-07 19:44:48 -04:00
parent f5c507a94b
commit a931013f3c
42 changed files with 39294 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
vue/README.md Normal file
View file

@ -0,0 +1,20 @@
# VUE
We are using are VueJS as a build tool to help create a modular version of the Fantasy Map Generator so that individual contributors can work with more manageable files.
## Goal
We could divide and conquer in steps.
* Quarter the codebase - take the 10K line codebase and create 4 script files containing 2.5K each
* repeat with each 2.5K file so that we're down to many 500 line or less files - about 16 files
* Create 1 main component which imports in all these functions.
Run the project and it should appear exactly like the 10K original script file except everything is modularized.
Once the codebase is divided into folders and sub folders and we're now leveraging import/export pattern to rebuild the main component by importing all the functions.
Then we could begin looking a candidates for other components such the editor overlay and also begin refactoring and modernizing the code to es6/7 standards.
## Tests
We need to figure out how to run the tests.