apinf / platform

Apinf - Open source API management platform with multi proxy and protocol support
https://apinf.com/
European Union Public License 1.1
74 stars 33 forks source link

Move all APInf packages' into /apinf_packages directory #2810

Closed brylie closed 7 years ago

brylie commented 7 years ago

Our project structure is currently very flat, with the top level containing many directories. This can be a bit disorienting when first glancing the source code.

Goal

Make the source code easier to understand by combining all project 'modules' under one directory.

saransh-dev commented 7 years ago

Hi Brylie,

I would like to inform you that, we can use meteor's suggest directory structure. But it can take the time to change.

Please advise.

Thanks. Regards, Saransh

brylie commented 7 years ago

Thanks @saransh-dev. We have reviewed the suggested directory structure.

One of our mid-to-long term goals is to try publishing our APInf 'components' as NPM packages, so that individual deployments could enable/disable packages of their choosing.

All this PR is proposing is that we move all of our APInf 'packages' into a sub-folder, e.g. /packages.

At a later point, the structure of each package could follow the recommendations of the Meteor Guide:

saransh-dev commented 7 years ago

Yes, it's a good idea to convert in packages @brylie

brylie commented 7 years ago

OK, thanks. So, do you think it is a reasonable step to move our current 'package-based' structure to a sub-folder? This is mainly for clarity and developer experience.

brylie commented 7 years ago

I am considering the directory name should be 'packages', since that word is used by both NPM and Bower.

The previous idea about a 'modules' directory was inspired by Drupal.

brylie commented 7 years ago

Basically, everyone in favor of moving all of our APInf packages into a 'packages' directory, upvote this comment. If opposed, downvote.

brylie commented 7 years ago

Pull request #2819 is open for comment. WORK-IN-PROGRESS :smile_cat:

mauriciovieira commented 7 years ago

I am glad :-)

brylie commented 7 years ago

Thanks @mauriciovieira. We are on Experimentation Mondays today. Do you think you might have time to check out the branch and fix any of the errors you might encounter related to imports, etc., so we can finish this ASAP?