sneha-4-22 / CryptoMate

💹Welcome to the CryptoMate Dashboard! 🤑.Explore the world of cryptocurrencies with ease. 🌐 Analyze trends, monitor market cap, and make informed decisions. 💡
https://crypto-mate-liard.vercel.app
13 stars 1 forks source link

enhancement: Usage section of the readme #2

Closed SusheelThapa closed 6 months ago

SusheelThapa commented 6 months ago

As I seen that you have added requirements.txt files in the project, you can replace the step 2 with pip install -r requirements.txt.

Also, it would be great if you included an step to create a virtual enviroment before installing the python packages like python -m venv venv

Moreover, you can use pip freeze > requirements.txt command to generate the requirements.txt files as this will ensure the version that you have used in the developement of the project match with the version other people with be running your project.

Sample of requirements.txt generated using above command.

taipy==3.1.0
taipy-config==3.1.0
taipy-core==3.1.0
taipy-gui==3.1.0
taipy-rest==3.1.0
taipy-templates==3.1.0

Addtionally, you can link the dependancies to their homepage as Taipy

In the about section of the project you have included emoji, it would be nice if you could write short description about the project as this help to index the project.

image

SusheelThapa commented 6 months ago

Also, I have some unnecessary folder in the project like .data __pycache__,etc

You can add a .gitignore files to exclude those folder.

sneha-4-22 commented 6 months ago

Done👩🏻‍💻