Fix pylint error and better README

README.md

@@ -1,10 +1,28 @@
-# Scouting App Demo
-> This is just made for fun
+# 334 Scouting App
+
+| Images | Images |
+| ---- | ----- |
+| ![Home unlogined](./assets/home.png) | ![Home logined](./assets/home-2.png) |
+| ![Scout](./assets/scout.png) | ![Add data](./assets/scout-2.png) |
+| ![Search](./assets/search.png) | ![Compare](./assets/compare.png) |
+
+## Prerequisite
+- [MongoDB compass](https://www.mongodb.com/try/download/community) - https://www.mongodb.com/try/download/community
+- [Python](https://python.org) - https://python.org
+
 
-![Demo](demo.png)
 
 ## How to install
 1. Clone the repo
-2. Inside of `app` folder, create a folder called `db` and inside `db` folder create a file named `tortoise.db`
+2. Create a database in [MongoDB compass](https://www.mongodb.com/try/download/community):
+![MongoDB Compass](./assets/mongodb.png)
+3. Create `.env` file in root directory, should look similar to this
+> Example:
+```
+SECRET_KEY=your_secret_key
+MONGO_URI=your_mongo_uri
+TBA_AUTH_KEY=your_tba_api_key
+DEBUG=False
+```
 3. Install the dependencies: `pip install -r requirements.txt`
 4. Run the app through (in parent directory outside of app): `python app/app.py`

app/scout/scouting_utils.py

@@ -101,8 +101,7 @@ def add_scouting_data(self, data, scouter_id):
 
             self.db.team_data.insert_one(team_data)
             logger.info(
-                f"Added new scouting data for team {
-                        data['team_number']}"
+                f"Added new scouting data for team {data['team_number']}"
             )
             return True, "Data added successfully"
         except Exception as e: