Skip to content

Commit

Permalink
added build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
DamourYouKnow committed Dec 2, 2018
1 parent 59d976d commit 7ca9090
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Build
## Instructions
1. Add a file named `auth.json` inside the `config` folder. This file will
contain your discord application's oauth token and optionally channel IDs for
logging errors and feedback:
```json
{
"token": "bottoken",
"error_log": "00000000000000000",
"feedback_log": "000000000000000000"
}
```

2. Use pip to install the project's dependencies:
```
pip install -r requirements.txt
```
3. Run an instance of
[MongoDB Server](https://www.mongodb.com/download-center?jmp=homepage#community).
I'd recommend using the default port for configuration purposes.
4. Run the application:
```
python main.py
```
Please note that the database of cards will be empty when you first run the app.
Card information is retreived from the School Idol Tomoachi API in batches of
10 cards every 2 minutes. It will take a few update cycles for all of the
features to function as designed.

0 comments on commit 7ca9090

Please sign in to comment.