Created README

This commit is contained in:
socks 2021-03-09 02:30:40 +00:00
parent 95956cc47c
commit 63a223bf24

31
README.md Normal file
View file

@ -0,0 +1,31 @@
Discord bot to track stock portfolios
## Install Guide
First, install dependencies and clone repo
```sh
# Required Dependencies
sudo apt install git python3.8 python pipenv
# Clone Repository
git clone git@git.sockspls.com:kate/stock-tracker-discord.git
```
Recommended: Install [MongoDB](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/) (Otherwise, flat file is used)
Then, create pipenv environment
```sh
cd stock-tracker-discord
pipenv install
```
Setup config file
```sh
cp config.example.py config.py
nano config.py
```
Run script
```sh
pipenv run main.py
```