mirror of
https://gitlab.com/simple-stock-bots/simple-stock-bot.git
synced 2025-06-15 14:56:40 +00:00
Update documentation, merge splash page into docs.
This commit is contained in:
parent
0cea1a38ab
commit
c58adc8995
54
README.md
54
README.md
@ -1,32 +1,44 @@
|
||||
# Simple Telegram Stock Bot
|
||||
# Simple Stock Bots
|
||||
|
||||
|
||||
[](https://t.me/SimpleStockBot)
|
||||
[](https://t.me/SimpleStockBot)
|
||||
[](/LICENSE)
|
||||
[](https://ansonbiggs.com)
|
||||
[](https://ansonbiggs.com)
|
||||
|
||||
## Docs
|
||||
Enhance your group chats on Telegram and Discord with real-time stock and cryptocurrency insights. Simple Stock Bots deliver timely stock quotes, charts, and market trends directly to your chats, making financial discussions more engaging and informed.
|
||||
|
||||
https://docs.simplestockbot.com/
|
||||
## Documentation
|
||||
|
||||
## Usage
|
||||
Comprehensive documentation is available to help you understand the features and capabilities of Simple Stock Bots:
|
||||
- [Official Documentation](https://docs.simplestockbot.com/)
|
||||
- [Command Reference](https://docs.simplestockbot.com/commands/)
|
||||
|
||||
https://docs.simplestockbot.com/commands/
|
||||
## Support the Project
|
||||
|
||||
## Donate
|
||||
Simple Stock Bots is sustained entirely through donations, with an annual expense of about $420 for server and premium market data subscriptions from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
||||
|
||||
Simple Stock Bot is run entirely on donations, and costs about $420 a year to run. All donations go directly towards paying for servers, and premium market data provided by [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
||||
You can contribute by:
|
||||
- Donating through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) (PayPal or Credit Card accepted).
|
||||
- Using the `/donate` [command](commands.md#donate-amount-in-usd) on Telegram.
|
||||
- [Getting in touch](contact.md) for any inquiries or suggestions.
|
||||
|
||||
The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) which accepts Paypal or Credit card.
|
||||
### Additional Support:
|
||||
|
||||
Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
|
||||
|
||||
If you have any questions get in [touch.](contact.md)
|
||||
|
||||
## Other Ways to Help:
|
||||
|
||||
- Follow me on [twitter](https://twitter.com/AnsonBiggs)
|
||||
- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
|
||||
- Using my referral links to host your own Bot
|
||||
- Follow on [Twitter](https://twitter.com/AnsonBiggs)
|
||||
- Contribute or star the project on [GitLab](https://gitlab.com/simple-stock-bots)
|
||||
- Utilize referral links for self-hosting:
|
||||
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||
- [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
|
||||
- [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
|
||||
|
||||
## Hosting
|
||||
|
||||
Self-hosting instructions are provided for those interested in running the bot on their own servers:
|
||||
- [Hosting Guide](https://docs.simplestockbot.com/hosting/)
|
||||
|
||||
## Contact
|
||||
|
||||
Reach out for bug reports, feature requests, or other inquiries:
|
||||
- [Contact Page](https://docs.simplestockbot.com/contact/)
|
||||
|
||||
---
|
||||
|
||||
Your support in any form is immensely appreciated and ensures the continuous improvement and availability of Simple Stock Bots for everyone.
|
||||
|
||||
@ -1,30 +0,0 @@
|
||||
# Simple Stock Bots
|
||||
[](https://t.me/SimpleStockBot)
|
||||
[](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
|
||||
## Table of Contents
|
||||
+ [About](#about)
|
||||
+ [Getting Started](#getting_started)
|
||||
+ [Usage](#usage)
|
||||
+ [Contributing](../CONTRIBUTING.md)
|
||||
|
||||
## About <a name = "about"></a>
|
||||
Simple Stock Bots is a family of messaging bots that aim to provide simple bots that provide information on the stock market. Currently there are only [Telegram](./telegram) and [Discord](./discord) Bots.
|
||||
|
||||
## Getting Started <a name = "getting_started"></a>
|
||||
|
||||
The simplest way to use these bots is to use the version that I host on Digital Ocean. You can find the links to access them below:
|
||||
|
||||
+ [Telegram](https://t.me/SimpleStockBot)
|
||||
+ [Discord](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot)
|
||||
|
||||
Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages.
|
||||
|
||||
## Source Code
|
||||
|
||||
The source code for the bots is completely open and hosted on Gitlab.
|
||||
|
||||
+ [Telegram](https://gitlab.com/simple-stock-bots/simple-telegram-bot)
|
||||
+ [Discord](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
||||
@ -1,6 +1,8 @@
|
||||
Feel free to reach out with bugs or suggestions at any of the following places:
|
||||
# I Would Love to Hear From You!
|
||||
|
||||
- Message me on [Telegram](https://t.me/MisterBiggs)
|
||||
- Message me on Discord `MisterBiggs#0465`
|
||||
- Tweet me on [Twitter](https://twitter.com/AnsonBiggs)
|
||||
- Open an issue on gitlab: [`Telegram Bot`](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot) [`Discord Bot`](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
||||
Your feedback and experience with Simple Stock Bot is invaluable. Whether you've encountered a bug, have a suggestion for improvement, or just want to share your experience, I'm all ears. Here are several ways you can get in touch:
|
||||
|
||||
- **Telegram**: Drop me a message on [Telegram](https://t.me/MisterBiggs).
|
||||
- **Discord**: Feel free to reach out on Discord at `MisterBiggs#0465`.
|
||||
- **Twitter**: Send me a tweet on [Twitter](https://twitter.com/AnsonBiggs).
|
||||
- **GitLab**: For technical issues or feature requests, feel free to open an issue on our [GitLab Repository](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot).
|
||||
|
||||
@ -1,15 +1,21 @@
|
||||
Simple Stock Bot is run entirely on donations, and costs about $420 a year to run. All donations go directly towards paying for servers, and premium market data provided by [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
||||
# Support Simple Stock Bot
|
||||
|
||||
The best way to donate is through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) which accepts Paypal or Credit card.
|
||||
Running Simple Stock Bot incurs a yearly expense of about $420, covering server costs and premium market data subscription from [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo). Every donation helps in maintaining the bot and ensuring its continued availability for all users.
|
||||
|
||||
Alternatively, you can donate on Telegram with the `/donate` [command](commands.md#donate-amount-in-usd).
|
||||
Your support through [Buy Me A Coffee](https://www.buymeacoffee.com/Anson) is greatly appreciated, which accepts both PayPal and Credit Card donations.
|
||||
|
||||
If you have any questions get in [touch.](contact.md)
|
||||
For Telegram users, a convenient way to donate is by using the `/donate` [command](commands.md#donate-amount-in-usd).
|
||||
|
||||
## Other Ways to Help:
|
||||
Should you have any inquiries, feel free to get in [touch](contact.md).
|
||||
|
||||
- Follow me on [twitter](https://twitter.com/AnsonBiggs)
|
||||
- Contribute to the project on [GitLab](https://gitlab.com/simple-stock-bots) or just leave a star
|
||||
- Using my referral links to host your own Bot
|
||||
- [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
|
||||
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||
## Additional Support:
|
||||
|
||||
Your engagement also counts as support! Here are other ways to contribute:
|
||||
|
||||
- Stay updated by following me on [Twitter](https://twitter.com/AnsonBiggs).
|
||||
- Contribute to the project or star it on [GitLab](https://gitlab.com/simple-stock-bots).
|
||||
- If you plan to host your own bot, consider using my referral links:
|
||||
- [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)
|
||||
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||
|
||||
Your support in any form is immensely appreciated and helps in keeping Simple Stock Bot operational and free for everyone.
|
||||
|
||||
@ -1,41 +1,47 @@
|
||||
# Self Hosted Bot
|
||||
# Self-Hosting Guide
|
||||
|
||||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
|
||||
This guide provides step-by-step instructions for setting up and running this project on your local machine, whether for development, testing, or personal use.
|
||||
|
||||
## Prerequisites
|
||||
## Pre-requisites
|
||||
|
||||
This project runs neatly in a docker container, so all that you need to run it yourself is [Docker](https://hub.docker.com/?overlay=onboarding) installed on your system.
|
||||
Ensure the following are installed or obtained before proceeding:
|
||||
|
||||
Depending on what platform you'll need:
|
||||
|
||||
- Telegram API key which can be obtained for free by talking to [BotFather](https://telegram.me/botfather), more details [here.](https://core.telegram.org/bots#3-how-do-i-create-a-bot)
|
||||
- Discord API key which can be obtained for free at [https://discord.com/developers](https://discord.com/developers)
|
||||
|
||||
Finally, you will need a [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) API key. They offer a free tier that should be enough for any private groups, more details [here.](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
|
||||
- **[Docker](https://hub.docker.com/?overlay=onboarding)**: The project is containerized using Docker Compose, allowing it to run on any system with Docker installed.
|
||||
- **API Keys**:
|
||||
- **Telegram**: Obtain a free API key by interacting with [BotFather](https://telegram.me/botfather). More details [here](https://core.telegram.org/bots#3-how-do-i-create-a-bot).
|
||||
- **Discord**: Get a free API key at [https://discord.com/developers](https://discord.com/developers).
|
||||
- **[marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web)**: Sign up to get an API key. A free tier is available and should suffice for private groups. More details [here](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo).
|
||||
|
||||
!!! tip
|
||||
The bot will function without a [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key and will fall back to only using cryptocurrency data.
|
||||
The bot will still operate without a [marketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) key but will revert to using only cryptocurrency data.
|
||||
|
||||
!!! note
|
||||
If you want to accept donations you also need a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]
|
||||
To enable donation acceptance, obtain a Stripe API key and provide a `STRIPE` key to your bot. [https://stripe.com/]()
|
||||
|
||||
## Installing
|
||||
## Setup Instructions
|
||||
|
||||
Once Docker is installed and you have your API keys for Telegram and [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo) getting the bot running on any platform is extremely easy.
|
||||
1. **Download/Clone the Repository**:
|
||||
- Download or clone this repository to your local machine.
|
||||
|
||||
Download or clone the repository to your machine and open a terminal in the project and build the Docker container.
|
||||
2. **Configure Environment Variables**:
|
||||
- Navigate to the project directory and locate the `.env` file.
|
||||
- Fill in the `.env` file with your obtained API keys:
|
||||
|
||||
```
|
||||
docker build -t simple-telegram-bot .
|
||||
```
|
||||
```plaintext
|
||||
MARKETDATA=your_marketdata_api_key
|
||||
STRIPE=your_stripe_api_key
|
||||
TELEGRAM=your_telegram_api_key
|
||||
DISCORD=your_discord_api_key
|
||||
```
|
||||
|
||||
Then run the bot using your API keys.
|
||||
Alternatively, pass the variables using Docker Compose environment variables or command-line arguments.
|
||||
|
||||
```
|
||||
docker run --detach \
|
||||
-e TELEGRAM=TELEGRAM_API_KEY \
|
||||
-e MARKETDATA=MARKETDATA_API_KEY \
|
||||
simple-telegram-bot
|
||||
```
|
||||
3. **Build and Run the Bot:**
|
||||
- Open a terminal in the project directory.
|
||||
- Build and run both bots using Docker Compose:
|
||||
|
||||
Your bot should be running! If you are new to Docker, I would recommend checking out its documentation for full control over your bot.
|
||||
```bash
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
Now, your bot(s) should be up and running! If you're unfamiliar with Docker, reviewing the [Docker documentation](https://docs.docker.com/) is highly recommended to gain better control over your bot and understand Docker commands better.
|
||||
|
||||
@ -1,29 +1,31 @@
|
||||
# Simple Stock Bots
|
||||
# Elevate Your Groupchats with Real-time Stock Insights
|
||||
|
||||
Simple Stock Bots is a family of messaging bots that aim to provide simple interface to stock market information.
|
||||
Discover a new level of financial discussion with Simple Stock Bot, your go-to solution for real-time stock market and cryptocurrency insights within your Telegram or Discord group chats. Transform your everyday discussions into an interactive financial exploration experience. With Simple Stock Bot, keeping up with the stock market or cryptocurrency trends has never been more seamless and engaging.
|
||||
|
||||
## Getting Started
|
||||
## [Commands](commands.md)
|
||||
|
||||
The bots can either be added to a server or can be direct messaged for the exact same functionality. Links for each platform are below:
|
||||
### Real-Time Stock and Cryptocurrency Updates
|
||||
- Get live price updates of stocks and cryptocurrencies.
|
||||
- Symbol Detection: Use `$` for stocks and `$$` for cryptocurrencies, e.g., `$tsla` for Tesla and `$$btc` for Bitcoin.
|
||||
|
||||
[Telegram Bot :fontawesome-brands-telegram:](https://t.me/SimpleStockBot){ .md-button .md-button--primary }
|
||||
### Intraday and Historical Data Visualization
|
||||
- `/intra`: View a stock's movement since the last market open or a cryptocurrency's 24-hour chart.
|
||||
- `/chart`: Provides a chart of the last month's trading data up till the day before.
|
||||
|
||||
[Discord Bot :fontawesome-brands-discord:](https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot){ .md-button .md-button--primary }
|
||||
### Trending Assets Awareness
|
||||
- `/trending`: Discover the latest trending stocks and cryptocurrencies and their price changes.
|
||||
|
||||
Alternatively, this project is completely open source and instructions on how to run your own instance of the bot are provided on each of the bots pages. [Hosting](host.md)
|
||||
### In-App Assistance and Support
|
||||
- `/help`: Provides a quick summary of available commands for easy reference.
|
||||
- `/donate`: Support the maintenance of the bot to ensure continued free access.
|
||||
|
||||
## Usage
|
||||
### User-Friendly Interaction
|
||||
- Easy symbol and command usage for a smooth user experience.
|
||||
- Engage with a community of financial enthusiasts and share insights effortlessly.
|
||||
|
||||
The bots are nearly identical between platforms, but sometimes a platform will have a feature that only it supports such as Telegrams inline messaging or Discords embeds. For full information see [Commands](commands.md)
|
||||
## [Contact](contact.md)
|
||||
Need assistance or have inquiries? Feel free to reach out and I'll be happy to help.
|
||||
|
||||
## Source Code
|
||||
## Powered by MarketData.app
|
||||
|
||||
The source code for the bots is completely open and hosted on GitLab. The project is licensed with an MIT License which is incredibly permissive. [The full text of the license can be read here](./LICENSE)
|
||||
|
||||
- [Telegram Bot Source](https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot)
|
||||
- [Discord Bot Source](https://gitlab.com/simple-stock-bots/simple-discord-stock-bot)
|
||||
|
||||
If you decide to host your own bots using my source code please consider using my referral links for marketdata.app and DigitalOcean. We both get a kickback when you use them.
|
||||
|
||||
- [DigitalOcean](https://m.do.co/c/6b5df7ef55b6)
|
||||
- [matketdata.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo)
|
||||
Simple Stock Bots is able to provide real-time stock market insights thanks to the data supplied by [MarketData.app](https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web). MarketData.app delivers accurate and up-to-date financial data, fueling the bot's capabilities in delivering timely stock quotes, charts, and other market-related information directly to your Telegram or Discord groups. The robust data infrastructure provided by MarketData.app not only ensures the reliability and accuracy of the information you receive but also enables the offering of Simple Stock Bots for free to all users. By leveraging MarketData.app's comprehensive financial data, the goal is to foster informed financial discussions and make market monitoring an effortless and accessible experience for everyone.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
site_name: Simple Stock Bot Docs
|
||||
site_url: https://docs.simplestockbot.com
|
||||
site_name: Simple Stock Bot
|
||||
site_url: https://simplestockbot.com
|
||||
edit_uri: /simple-stock-bots/site/tree/master/docs
|
||||
repo_url: https://gitlab.com/simple-stock-bots
|
||||
repo_url: https://gitlab.com/simple-stock-bots/simple-telegram-stock-bot
|
||||
repo_name: Simple Stock Bots
|
||||
|
||||
site_description: Simple Discord and Telegram chat bots for Stock Market Data.
|
||||
@ -12,7 +12,7 @@ copyright: <a href="https://ansonbiggs.com">Anson Biggs</a> 2018 </br> Available
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Commands: commands.md
|
||||
- Hosting: host.md
|
||||
- Self-Host: host.md
|
||||
- Donate: donate.md
|
||||
- Contact: contact.md
|
||||
|
||||
@ -24,7 +24,7 @@ theme:
|
||||
- navigation.tracking
|
||||
- navigation.tabs
|
||||
- navigation.tabs.sticky
|
||||
- navigation.footer
|
||||
- content.code.copy
|
||||
icon:
|
||||
logo: material/robot-love
|
||||
palette:
|
||||
@ -52,7 +52,7 @@ extra:
|
||||
link: https://discordapp.com/api/oauth2/authorize?client_id=532045200823025666&permissions=36507338752&scope=bot
|
||||
name: Get the Discord Bot
|
||||
- icon: material/chart-line-stacked
|
||||
link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=repo
|
||||
link: https://dashboard.marketdata.app/marketdata/aff/go/misterbiggs?keyword=web
|
||||
name: MarketData.app for stock data
|
||||
|
||||
|
||||
@ -68,7 +68,10 @@ plugins:
|
||||
|
||||
|
||||
markdown_extensions:
|
||||
- attr_list
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- attr_list
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user