Skip to content

Wall-Street-Bets/Stock-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


The Wall Street Bets Discord bot

An awesome investing simulator that tracks real market data!
Invite the bot to get started »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

There are many amazing discord bots out there that everyone loves - Dank memer, Mee6, CarlBot etc. I wanted to make a bot that is fun for everyone, so I decided that making a financial stock game bot will be the best one -- maybe the last stock bot you will need on discord.

More features will be added in the feature, you may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to everyone who contributed to this bot!

Use the README.md to get started.

(back to top)

Built With

  • Discord.js
  • Node.js
  • Prisma

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://polygon.io
  2. Clone the repo
git clone https://github.com/Wall-Street-Bets/Stock-bot.git
  1. Install NPM packages and prisma
npm install
npx prisma generate
  1. Enter your Bot Key and API Key in .env
TOKEN="ENTER YOUR TOKEN KEY"
API_KEY="ENTER YOUR API KEY"
DATABASE_URL="ENTER YOUR MONGODB URL"
CLIENT_ID="ENTER THE ID OF THE BOT"
# GUILD_ID="ENTER THE GUILD ID OF THE BOT IF YOU ONLY NEED IT TO RUN IN ONE GUILD"
  1. Push to the DB!
npx prisma db push
  1. Run the bot!
npm run start

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add a crypto feature as well
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme
  • Multi-language Support
    • Chinese
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Elbert_Ainstein - @ainstein_elbert - [email protected]

pennacap - @PennaCap

Project Link: https://github.com/Wall-Street-Bets/Stock-bot.git

(back to top)

Acknowledgments

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •