fraction / oasis

Free, open-source, peer-to-peer social application that helps you follow friends and discover new ones on Secure Scuttlebutt (SSB).
http://oasis-demo.fraction.io
GNU Affero General Public License v3.0
286 stars 42 forks source link

Refactoring code base for easier maintaining #613

Closed Roxxers closed 1 year ago

Roxxers commented 3 years ago

What's the problem you want solved?

As discussed in a few meetings, the size of files has ballooned over the projects lifespan. Quite a lot of js files (and the main css file) exceed 1000 lines. This is incredibly unwieldy to newcomers of the project and those without an intimate knowledge of the code base. This is especially an issue with what would be considered separate parts of code within the same file. (Main example of this is all of the projects routes are basically hidden in the middle of the main index.js file.

Is there a solution you'd like to recommend?

I will lay out a general plan of what code I will refactor into new files for a better structure that is more maintainable and welcoming to new contributors. These will be done in stages via PR's as to not just create one giant PR full of breaking changes for other contributors but this should not change the general running of the app whatsoever.

Plan