Showndarya / Hacktoberfest

A collection of words! :star: it if you :+1: it !
https://showndarya.github.io/Hacktoberfest/Contributors_Page_Source/
MIT License
274 stars 1.92k forks source link

💡 Restructure project #810

Open jukefr opened 6 years ago

jukefr commented 6 years ago

I was thinking that the more services we add the dirtier the project structure will get, this can drive away contributors who simply want to add words for now.

So I was thinking, and welcome a debate about this, of restructuring the folders this way :

/src -> all services code goes there
/A
/B
/C...
any_needed_files_here.xx

Also as this project has no definitive goal and new stuff gets added daily, inside /src we would simply adopt a "micro-service" architecture that and we simply have one folder per service like so :

/src
/src/api
/src/speech
/src/...

At a later stage of the project when we have enough word contributions I think putting the word folders inside a /data folder would make everything way more clean, so it would look like this :

/src -> all services code goes there
/data
any_needed_files_here.xx

with

/data
/data/A
/data/B
...

To prepare for this we would also have to modify any scripts thats use the data to take an environment variable (like DATA_PATH) instead so that we can change the data path at any time :)

Tell me what you think and if you would do anything differently.

Showndarya commented 6 years ago

@jukefr

It seems proper to me.

Can we wait for other suggestions or should I start with it?

jukefr commented 6 years ago

You decide, while you do this if you could add some environment variables on Travis that I can use for Now it would be very nice :)

something like NOW_USER and NOW_PASS

you can set options so that they never get displayed publicly

YashKumarVerma commented 5 years ago

I think it must be done +1