Automate Trading with Ease!
All In One Management Tool for freqtrade with NostalgiaForInfinityX strategy
Table of Contents
NFI-NG is an all-encompassing tool designed to facilitate the establishment of a solid Freqtrade environment utilizing the NostalgiaForInfinityX strategy. It boasts a suite of features such as assisted installation, configuration management, and automated updates. Moreover, NFI-NG delivers a user-friendly terminal interface for bot and configuration management, and streamlines updates with Telegram notifications, enabling newcomers to effortlessly set up and oversee their requirements without delving into Freqtrade documentation or editing configuration files manually.
| Feature | Description |
|---|---|
| ⚙️ Architecture | The project's architecture enables setting up a Docker container for Freqtrade, configuring it to run the NFIX strategy, store data, and log progress. |
| 📄 Documentation | Additional documentation for clarity on certain features is in progress. |
| 🔌 Integrations | Integrations include textual and requests for automated bot management and configuration settings. |
| 🤖 Scripting | Scripts available in the repository are: bot_management_gui.py - creates a GUI for managing bot configurations, install_docker.py - handles OS-agnostic Docker installation processes, auto_update.py - automates strategy updates and sends Telegram notifications, tui_setup_wizard.py - setup wizard for orchestrating NFI-NG's installation process. |
| 🔧 Docker | Docker containers are utilized in the project setup to enable configuration of the NFIX strategy, storage of data, and logging progress. |
| 👥 Telegram | The project integrates with Telegram for sending notifications related to strategy updates. |
| 💻 Setup Wizard | The setup wizard script guides users through the installation process by prompting them for necessary API keys, tokens, and chat IDs. |
System Requirements:
- Python:
Tested on 3.12
- Linux:
$ curl -fsSL https://raw.githubusercontent.com/lsiem/NFI-NG/master/setup.sh | sh
- Windows
$ Invoke-WebRequest -Uri "https://raw.githubusercontent.com/lsiem/NFI-NG/main/setup.ps1" -OutFile "setup.ps1"; .\setup.ps1
Run NFI-NG using the command below:
$ > NFI-NG start
-
► Initial alpha release with all the essential features -
► Improve code documentation and overall structure -
► Improving the user interface -
► Add more configurable options for installation -
► Better bot management by providing a WebUI with logs, current configuration, profit and so on...
Contributions are welcome! Here are several ways you can contribute:
- Report Issues: Submit bugs found or log feature requests for the
NFI-NGproject. - Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone https://github.com/lsiem/NFI-NG
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to github: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
Details about the license can be found here: LICENSE.
- freqtrade for providing the actual crypto bot (https://www.freqtrade.io/en/stable/)
- iterativv for providing the trading strategy (https://github.com/iterativv/NostalgiaForInfinity)