- Welcome to meme investment!
- Contributing
- Investment behaviour
- Commands
- Getting started
- Prerequisites
- Installation and configuration
- Deployment
- Source code
- Authors
- License
Welcome to the source code repository of u/MemeInvestor_bot. This bot has been developed exclusively for r/MemeEconomy. It allows users to create investment accounts with fictional MemeCoins, invest those MemeCoins in specific memes, and automatically evaluate meme performance resulting in positive or negative returns.
The README below is a bit outdated. New version will be soon.
If you want to contribute, please do so! Check the Issues list and help meme investments thrive!
The bot has the following commands:
!create- creates a bank account for you with a new balance of 1000 MemeCoins.!invest AMOUNT- invests AMOUNT in the meme (post). 4 hours after the investment, the meme growth will be evaluated and your investment can profit you or make you bankrupt. Minimum possible investment is 100 MemeCoins.!balance- returns your current balance.!active- returns a number of active investments.!broke- only if your balance is less than 100 MemeCoins and you do not have any active investments, declares bankruptcy on your account and sets your balance to 100 MemeCoins (minimum possible investment).!market- gives an overview for the whole Meme market.!top- gives a list of the users with the largest account balances.!ignore- ignores the whole message.!help- returns this help message.
To invoke a command, reply to either the top-level u/MemeInvestor_bot comment in the comment section of any r/MemeEconomy post or to one of its subsequent replies to your command comment.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
In order to run this application, you need to install Docker.
The only thing that needs to be done before execution is the config profile. For that please follow the steps below:
git clone https://github.com/MemeInvestor/memeinvestor_bot.git
cd memeinvestor_bot
cp .env.example .env
nano .env
Follow the instructions in .env to configure your test deployment, save the file, and exit. You're done with configuration.
From the root of the project directory, use docker-compose build followed by docker-compose up -d
to build and launch the various components of the bot, including an empty database of investor
accounts, the agents that monitor Reddit for new submissions and commands, and the informational
website.
You should be able to view the website at http://localhost:2015. By default the stats will be
boring (no investors and no investments) but you can interact with your test bot on Reddit to
populate the database, or you can manually set up investor accounts by interacting with the
database directly via Python code or a database manager like adminer.
- Sagindyk Urazayev - Core developer. Initial work & SQLite - thecsw
- Dimitris Zervas - Main back-end developer. MySQL, Docker, API and overall support - dzervas
- jimbobur - Our maths guy. Can make really pretty graphs - jimbobur
- Alberto Ventafridda - Main front-end and web developer - robalb
- rickles42 - Back-end and infrastructure developer - rickles42
- TwinProduction - Heavy outside contributor - TwinProduction
- ggppjj - Minor fixes - ggppjj
This project is licensed under the The GNU General Public License (see the LICENSE file for details), it explains everything pretty well.