Skip to content

Commit 5f64383

Browse files
committed
Merge branch 'dev' into 'main'
Docs: improve repo discoverability and cross-linking See merge request AndreyPopov/spot-trading-bot!43
2 parents 20c999d + f66270f commit 5f64383

5 files changed

Lines changed: 92 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Changelog
22

3+
## v2.0.2
4+
5+
### Added
6+
7+
- Public GitLab Pages documentation link from the repository front page.
8+
- Dedicated developer documentation page with release command examples.
9+
- AI usage guidance in the docs for setup, deployment, and manual review expectations.
10+
11+
### Fixed
12+
13+
- Auto-create pair state for live params.
14+
- Suppressed `npm` update/fund noise in the Docker setup flow.
15+
316
## v2.0.1
417

518
### Added

DOCKERHUB.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ keys and never sends your credentials anywhere. Runs on testnet out of the box.
77
- **Image:** `5879/spot-trading-bot`
88
- **Tags:** `latest`, `X.Y.Z` (pin a version for stability)
99
- **Architectures:** `linux/amd64`, `linux/arm64` (Intel & Apple Silicon)
10+
- **GitLab (canonical):** <https://gitlab.com/AndreyPopov/spot-trading-bot>
11+
- **GitHub mirror + feedback:** <https://github.com/PopovAndrii/spot-trading-bot>
12+
- **Documentation site (GitLab Pages):** <https://exchange-crypto-059f74.gitlab.io/>
13+
- **Documentation site (GitHub Pages):** <https://popovandrii.github.io/spot-trading-bot/>
14+
- **Docker Hub:** <https://hub.docker.com/r/5879/spot-trading-bot>
1015

1116
---
1217

@@ -23,6 +28,7 @@ keys and never sends your credentials anywhere. Runs on testnet out of the box.
2328
| 7 | **Testnet-first, with a safety fallback.** Ships with no keys and defaults to Binance testnet; `real` mode without real keys silently falls back to testnet, so you can't trade real funds by accident. |
2429
| 8 | **Manual per-order control (Expert Mode).** Cancel and re-place individual live orders by hand when you want to intervene. |
2530
| 9 | **Free, open source, and yours to run 24/7.** GPLv3, self-hosted — no subscription, no third party between you and the exchange. |
31+
| 10 | Authorization allows you to securely deploy the application on a **VPS server for round-the-clock operation**. |
2632

2733
---
2834

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
11
# Spot Trading Bot for Binance
22

3+
![Node.js](https://img.shields.io/badge/Node.js-20+-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
4+
![Express](https://img.shields.io/badge/Express-5-000000?style=for-the-badge&logo=express&logoColor=white)
5+
![Docker](https://img.shields.io/badge/Docker-Compose-2496ED?style=for-the-badge&logo=docker&logoColor=white)
6+
![Binance Spot](https://img.shields.io/badge/Binance-Spot-F3BA2F?style=for-the-badge&logo=binance&logoColor=black)
7+
![WebSocket](https://img.shields.io/badge/WebSocket-ws-010101?style=for-the-badge&logo=socketdotio&logoColor=white)
8+
![SCSS](https://img.shields.io/badge/SCSS-Styling-CC6699?style=for-the-badge&logo=sass&logoColor=white)
9+
10+
[![GitHub stars](https://img.shields.io/github/stars/PopovAndrii/spot-trading-bot?style=for-the-badge)](https://github.com/PopovAndrii/spot-trading-bot/stargazers)
11+
[![Docker Pulls](https://img.shields.io/docker/pulls/5879/spot-trading-bot?style=for-the-badge&logo=docker)](https://hub.docker.com/r/5879/spot-trading-bot)
12+
[![GitHub release](https://img.shields.io/github/v/release/PopovAndrii/spot-trading-bot?style=for-the-badge)](https://github.com/PopovAndrii/spot-trading-bot/releases)
13+
[![License](https://img.shields.io/github/license/PopovAndrii/spot-trading-bot?style=for-the-badge)](LICENSE)
14+
[![Docs](https://img.shields.io/badge/Docs-Online-blue?style=for-the-badge)](https://popovandrii.github.io/spot-trading-bot/)
15+
[![Docker Hub](https://img.shields.io/badge/Docker%20Hub-5879%2Fspot--trading--bot-2496ED?style=for-the-badge&logo=docker&logoColor=white)](https://hub.docker.com/r/5879/spot-trading-bot)
16+
17+
If this project helps you, please consider starring the repository on GitHub or GitLab, and feel free to leave feedback on either platform.
18+
319
![Spot Trading Bot for Binance dashboard](docs/public/img/long_DCA_grid_hybrid/Screenshot_20260719_122737.png)
420

5-
> **Canonical repository:** GitLab — development, issues, merge requests, and releases happen there.
6-
> **GitHub:** read-only mirror for visibility and easier discovery.
21+
> **Canonical repository:** GitLab — development, merge requests, and releases happen there.
22+
> **GitHub:** public mirror for visibility, stars, and feedback.
723
824
Self-hosted spot trading bot for Binance with a web dashboard.
925
Runs with **your own** API keys, defaults to **testnet**, and stores its state locally.
1026

1127
- **GitLab (canonical):** <https://gitlab.com/AndreyPopov/spot-trading-bot>
12-
- **GitHub mirror:** <https://github.com/PopovAndrii/spot-trading-bot>
13-
- **Documentation site:** <https://exchange-crypto-059f74.gitlab.io/>
28+
- **GitHub mirror + feedback:** <https://github.com/PopovAndrii/spot-trading-bot>
29+
- **Documentation site (GitLab Pages):** <https://exchange-crypto-059f74.gitlab.io/>
30+
- **Documentation site (GitHub Pages):** <https://popovandrii.github.io/spot-trading-bot/>
31+
- **Docker Hub:** <https://hub.docker.com/r/5879/spot-trading-bot>
1432
- **Documentation sources:** VitePress docs in `docs/`
1533

1634
## Quick start
@@ -65,6 +83,23 @@ docker compose down # stop
6583
- Developer notes: `docs/developer/for-developers.md`
6684
- Disclaimer: `docs/help/disclaimer.md`
6785

86+
## 🛠️ Need Help with Deployment?
87+
88+
While this project is fully open-source and free to set up on your own using the provided Docker guidelines, I offer paid **DevOps & Server Setup Assistance** if you prefer a turn-key technical installation:
89+
90+
- **VPS / Ubuntu Server Setup:** Initial server hardening, firewall setup, and Docker/Docker Compose installation.
91+
- **Environment Configuration:** Proper system setup and process monitoring (systemd / PM2).
92+
- **Consultation:** 1-on-1 call via Zoom/Discord to walk you through the architecture and running process safely.
93+
94+
> ⚠️ **Disclaimer:** I provide purely technical infrastructure and DevOps support for open-source software setup. I do **not** provide financial advice, trading strategies, or key management services. You are fully responsible for your own exchange API keys and funds.
95+
96+
<p align="center">
97+
<a href="mailto:vps.support.bot@gmail.com">
98+
<img src="https://img.shields.io/badge/Email-Deployment_Support-blue?style=for-the-badge&logo=gmail" alt="Email Support" />
99+
</a>
100+
</p>
101+
102+
68103
## License
69104

70105
**Copyright © 2026 Andrii Popov.**

docker-config/Dockerfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ RUN apt-get update && apt-get install -y --no-install-recommends curl procps git
1111

1212
WORKDIR /var/www
1313

14+
# Silence npm's "New version of npm available" banner and the funding footer in
15+
# every stage — build logs and deploy output should carry only our own messages.
16+
ENV NPM_CONFIG_UPDATE_NOTIFIER=false
17+
ENV NPM_CONFIG_FUND=false
18+
1419
# ---------- dev: код и node_modules приходят bind-mount'ом (compose.yml) ----------
1520
FROM base AS dev
1621
USER node

docs/index.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,13 @@ features:
3030

3131
## Releases
3232

33-
Current version: **`2.0.1`**.
33+
Current version: **`2.0.2`**.
3434

3535
Every new version is added to this list with a short note on what changed. Newest first.
3636

3737
| Version | Date | Notes |
3838
|---|---|---|
39+
| **`2.0.2`** | 2026-07-26 | Public docs link from the repo front page, developer release command examples, AI usage guidance in docs, auto-create pair state for live params, and quieter Docker setup output. |
3940
| **`2.0.1`** | 2026-07-20 | Live re-place of the resting micro when Micro profit % changes (atomic `cancelReplace`). VitePress docs site, rebrand + new logo, Docker Hub image rename. Fixes: resting micro shows its real book price; re-place popup price rounded to tick. |
4041
| **`2.0.0`** | 2026-07-17 | First test release. DCA/Grid hybrid strategy — safety-order ladder, averaged grid close that follows real fills, and a micro-scalp that banks oscillations and pulls the exit closer. Live hybrid controls on a running cycle, Telegram trade notices, testnet-first, and Docker Hub distribution. |
4142

@@ -44,12 +45,35 @@ Every new version is added to this list with a short note on what changed. Newes
4445
Open source under GPLv3.
4546

4647
::: tip Development happens on GitLab
47-
The **GitLab repository is canonical**: active development, issues, merge requests,
48+
The **GitLab repository is canonical**: active development, merge requests,
4849
and releases happen there.
4950

50-
The **GitHub repository is a read-only mirror** for visibility and easier discovery.
51-
Please open issues and contributions on GitLab.
51+
The **GitHub repository is a public mirror** for visibility, stars, and feedback.
52+
For code changes and releases, GitLab remains the primary home.
5253
:::
5354

5455
- **GitLab (canonical):** [gitlab.com/AndreyPopov/spot-trading-bot](https://gitlab.com/AndreyPopov/spot-trading-bot)
55-
- **GitHub mirror:** [github.com/PopovAndrii/spot-trading-bot](https://github.com/PopovAndrii/spot-trading-bot)
56+
- **GitHub mirror + feedback:** [github.com/PopovAndrii/spot-trading-bot](https://github.com/PopovAndrii/spot-trading-bot)
57+
- **Documentation site (GitLab Pages):** [exchange-crypto-059f74.gitlab.io](https://exchange-crypto-059f74.gitlab.io/)
58+
- **Documentation site (GitHub Pages):** [popovandrii.github.io/spot-trading-bot](https://popovandrii.github.io/spot-trading-bot/)
59+
- **Docker Hub:** [hub.docker.com/r/5879/spot-trading-bot](https://hub.docker.com/r/5879/spot-trading-bot)
60+
61+
::: tip Support the project
62+
If this project helps you, consider starring it on [GitHub](https://github.com/PopovAndrii/spot-trading-bot) or [GitLab](https://gitlab.com/AndreyPopov/spot-trading-bot), and feel free to leave feedback on either platform.
63+
:::
64+
65+
## 🛠️ Need Help with Deployment?
66+
67+
While this project is fully open-source and free to set up on your own using the provided Docker guidelines, I offer paid **DevOps & Server Setup Assistance** if you prefer a turn-key technical installation:
68+
69+
- **VPS / Ubuntu Server Setup:** Initial server hardening, firewall setup, and Docker/Docker Compose installation.
70+
- **Environment Configuration:** Proper system setup and process monitoring (systemd / PM2).
71+
- **Consultation:** 1-on-1 call via Zoom/Discord to walk you through the architecture and running process safely.
72+
73+
> ⚠️ **Disclaimer:** I provide purely technical infrastructure and DevOps support for open-source software setup. I do **not** provide financial advice, trading strategies, or key management services. You are fully responsible for your own exchange API keys and funds.
74+
75+
<p align="center">
76+
<a href="mailto:vps.support.bot@gmail.com">
77+
<img src="https://img.shields.io/badge/Email-Deployment_Support-blue?style=for-the-badge&logo=gmail" alt="Email Support" />
78+
</a>
79+
</p>

0 commit comments

Comments
 (0)