CryPrice is a command-line cryptocurrency tool that interacts with Kraken's public API to fetch real-time asset and trading data. This project is still under development and requires several key features and improvements.
CryPrice aims to become a robust and user-friendly cryptocurrency price tracking tool. While basic functionality exists, there are many features that still need to be implemented. Some of the planned improvements include:
- Enhanced Error Handling: Current error handling needs refinement, especially when interacting with the Kraken API.
- Real-Time Charts: Implementing support for live and historical cryptocurrency charting.
- Asset Pair Data: The tool should provide more detailed information on asset pairs.
- Expanded API Support: Extend the application to work with other cryptocurrency exchanges beyond Kraken.
- User Settings & Preferences: Add functionality for users to customize the data they see.
- Performance Optimization: Streamlining data fetching and improving response times for better user experience.
To clone and set up the project locally:
-
Clone the repository:
git clone https://github.com/energelpen/CryPrice.git
-
Navigate to the project directory:
cd CryPrice -
Install dependencies:
npm install
We welcome contributions to CryPrice! Here are a few areas that need attention:
- Feature Requests: Implement new features like chart support, additional exchanges, or advanced data queries.
- Code Optimization: Improve the structure, performance, and readability of the existing codebase.
- Testing: Write unit and integration tests to ensure reliability.
- Bug Fixes: Help identify and resolve existing issues in the functionality.
To contribute, please:
-
Fork the repository.
-
Create a feature branch:
git checkout -b feature-branch
-
Commit your changes:
git commit -m 'Add some feature' -
Push to the branch:
git push origin feature-branch
-
Open a pull request.
CryPrice is intended for learning purposes only. The authors of this project are not liable for any loss or harm resulting from the use of this software. All cryptocurrency data is provided by Kraken's public API, and the accuracy or reliability of the data cannot be guaranteed.
Please use this tool with caution, especially when making financial decisions, as the data fetched may not always be up-to-date or accurate. CryPrice and its authors are not responsible for any trading or investment actions you take based on the information provided.