Futura-Py / TimerX

A fluent Timer App, made completely in Python
https://timerx-app.netlify.app
MIT License
37 stars 5 forks source link

Clean Up Repository #52

Closed not-nef closed 2 years ago

not-nef commented 2 years ago

The repository definitely needs some cleaning. Its just a big mess atm. A few things i suggest doing:

im-coder-lg commented 2 years ago

Nice idea, but I did try that. docs seems a simpler idea than website and we could add the same data of CODE_OF_CONDUCT.md, etc. in the documentation. I think the Scripts folder is used to make a VENV on Windows. No use moving repo data to docs. Putting all the requirements-*.txt together would be hard since win10toast exists only on Windows. Some modules are unavailable on Linux and macOS and it'd be better to load the required modules.

im-coder-lg commented 2 years ago

Maybe let's make a cleanup branch and clean up the entire code. I'll try reformatting the website using Prettier and try Jest(idk they call it code coverage, what's it used for?) and use black and other Python code formatters to format the code neatly.

not-nef commented 2 years ago

Nonono, you understood me wrong. We can keep the files seperate, just move them all in one folder

sumeshir26 commented 2 years ago

Remove the .vscode folder since it isnt needed

Yeah, will do

Put all the requirements*.txt in a single dependencies folder (dont forget to update the docs)

No, because it is not python convention to put in in a folder

Maybe delete the Scripts folder? (idk what its used for)

Yes, will do

im-coder-lg commented 2 years ago

I hate the GitHub UI. Makes it hard to locate new comments while on that page. They need to fix that.

not-nef commented 2 years ago

No use moving repo data to docs.

Well, we would have 4 less files in the root dir

im-coder-lg commented 2 years ago

Well, we would have 4 less files in the root dir

Those files must be in the repo dir. Don't blame me, it's GitHub convention.

not-nef commented 2 years ago

Well, we would have 4 less files in the root dir

Those files must be in the repo dir. Don't blame me, it's GitHub convention.

No, they don't

Proof ![image](https://user-images.githubusercontent.com/83908932/149719055-e628707e-b538-4aba-b770-c5e182840d0a.png) ![image](https://user-images.githubusercontent.com/83908932/149719064-e4d93fcb-2acd-45c5-b855-763bd3a7702f.png) ![image](https://user-images.githubusercontent.com/83908932/149719069-622b0a98-bee3-4016-a4ba-c82dfb9a37b3.png)
im-coder-lg commented 2 years ago

Great, I'll edit this in the cleanup branch now.

im-coder-lg commented 2 years ago

Also, don't get me wrong, I am putting a collapsor via HTML so that we could save some screen space.

not-nef commented 2 years ago

No, because it is not python convention to put in in a folder

wut

not-nef commented 2 years ago

Also, don't get me wrong, I am putting a collapsor via HTML so that we could save some screen space.

Epic

im-coder-lg commented 2 years ago

Following conventions might give you a solid five-star rating since everything is organized. That's my motto. I like a neat workspace, it's a habit.

im-coder-lg commented 2 years ago

Moreover, the collapsor is literally this:

<details>
<summary>Short title</summary>

Start details after a space to format Markdown.

End with a space.

</details>

Done.

sumeshir26 commented 2 years ago

wut

If you see any big python repos, the requirements file is NEVER in a folder

im-coder-lg commented 2 years ago

They just keep them in a file and make sure they use cross-platform modules.

not-nef commented 2 years ago

wut

If you see any big python repos, the requirements file is NEVER in a folder

but we have 3 of them

im-coder-lg commented 2 years ago

I think it's best to let them be.

im-coder-lg commented 2 years ago

I'm also helping here. Basically, I think cleaning up the repo would also include organizing the files, so I am also assigning this to myself.