Clean Code architecture

tushar1210 / manga-node

Open Manga APIs

https://manganode.herokuapp.com

3 stars 0 forks source link

Clean Code architecture #106

Closed tushar1210 closed 3 years ago

tushar1210 commented 3 years ago

Need to settle upon schema of interfaces, nomenclature of methods, properties, and interfaces. @saqsham suggestions?

saqsham commented 3 years ago

ok so, directory names should be smallcase functions - camelCase endpoints - smallcase and no "-" or "_" class names - PascalCase variables - camelCase all static content should go to the public dir

In helpers/mangakakalot you put the Scrapper code, instead put the code/file in Models ? same for mangasee Scrapper, I recommend making the hotUpdates and other related functions in Models or in Scrapper itself, at one place I mean.

tushar1210 commented 3 years ago

[x] directories
[x] functions
[x] endpoints
[x] class names
[x] variables
[x] public dir

saqsham commented 3 years ago

We should maintain two apps, right ? One for user auth etc. stuff and other for manga-node. The api key will be attached with each user's account, and will be used in header for fetching data. so remove the sqlz dir I guess and the related packages.

tushar1210 commented 3 years ago

@saqsham yes i guess it will be better that way, if you want you can make a fresh repo.

tushar1210 commented 3 years ago

All advised changes are made with #111