search

zmon / Code-for-America-Projects-Hub

Help Brigade members find projects to work on. Promote multi-Brigade collaboration. Onboard new members. Encourage public contribution of ideas. Karma. Visualize scope for Code for America. Provide filtered and sorted card list of projects and ideas for development. The list should be available nation-wide and by city.
http://codeforkc.org/Code-for-America-Projects-Hub/
15 stars 13 forks source link

Clarify directory structure, organizing by components #68

Closed jstirnaman closed 9 years ago

jstirnaman commented 9 years ago

@reggieroby @zmon Can we pick one of these feature-organizing patterns? Whichever works the best. We should cause the least confusion possible for developers familiar with MVC or not. https://github.com/johnpapa/angular-styleguide#style-y152 https://scotch.io/tutorials/angularjs-best-practices-directory-structure#a-better-structure-and-foundation

zmon commented 9 years ago

It looks like what we have is close to the LIFT guidelines described in johnpapa Angular Style Guide

I like "A Better Structure and Foundation" in AngularJS Best Practices: Directory Structure. I like that shared things are broken out, but it does add a extra directory level.

Unfortunately I have not done any coding on this project.

I have been reminded by @jstirnaman that it does not matter where the files are located as long as they are pulled in, in the right sequence.

jstirnaman commented 9 years ago

I've started reorganizing according to the suggested "organize by feature" in the Angular Style Guide. The structure will look generally like this: CodeForAmericaProjectsHub/ --app/ ----dashboard/ ----data/ ----idea/ ----project/ ----app.module.js --assets/ --bower_components/ --index.html

tangospring commented 9 years ago

I recommend keeping 'hub' as a folder, not 'dashboard'. Here is why: Dashboard refers to charts and gadgets.Hub refers to hub-and-spoke navigation model we use in the projects hub.

jstirnaman commented 9 years ago

@tangospring Done. Thanks for the clarification.

jstirnaman commented 9 years ago

Reorg by feature is completed with 2b851ed2e6479e0d327c4fe29208ffb6a2bee99c