/Stonks

A discord bot that gives you information about the stock market

Primary LanguageGoMIT LicenseMIT


Stonks

A discord bot designed to give users information about the stock market.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Acknowledgements

About The Project

DISCAIMER: This project is the early stages and the commands can change at any point.

When I looked around, there weren't many Discord bots for the stock market, and the bots I did find weren't in a format that I liked or were missing features I wanted. Since they were lacking things I wanted, I decided to make my own with a nicer format and different features.

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

A couple of things youll need before you can have Narwhal up and running:

Installation

  1. Get your API keys
  2. Clone the repo 
    git clone https://github.com/Alackey/Stonks.git
  3. Download the go modules 
    go mod download
  4. Set environment variables manually, or copy the .env.example and create a .env file with the environment variables
  5. Start the bot 
    go run .

AWS Elastic Beanstalk

I am currently hosting this bot on AWS Elastic Beanstalk, and to deploy this app to a currently existing Elastic Beakstalk environment you would run the command below.

eb deploy {ENVIRONMENT_NAME}

This command uses the Buildfile and Procfile for building and deploying the bot to Elastic Beanstalk.

Usage

All commands begin with the default "$" prefix. For example:

 $somecommand arg1 arg2 ...arg

Commands

$q <symbol> - Gets the price information of a stock based off the symbol

$futures - Gets the price information for some futures

$market - Shows a heatmap of the market and its sectors

$market crypto - Shows a heatmap of the crypto market

$news <symbol> - Gets the most recent news about a stock based off the symbol

$help - Shows a list of available commands

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements