README
This commit is contained in:
66
README.md
66
README.md
@@ -1,75 +1,75 @@
|
|||||||
# Game Twacker App ʕ•ᴥ•ʔ
|
# Game Tracker App
|
||||||
|
|
||||||
A web appwication fow twacking videogames you'we cuwwently pwaying or compweting! This app uses the IGDB (Intewnet Game Database) API to seawch fow games and save them to youw pewsonal twacking wist~
|
A web application for tracking videogames you're currently playing or completing. This app uses the IGDB (Internet Game Database) API to search for games and save them to your personal tracking list.
|
||||||
|
|
||||||
## Featuwes ✨
|
## Features ✨
|
||||||
|
|
||||||
- Seawch fow games thwough the IGDB API
|
- Search for games through the IGDB API
|
||||||
- Twack up to 5 games you'we cuwwently pwaying
|
- Track up to 5 games you're currently playing
|
||||||
- Update game pwogwess (0-100%)
|
- Update game progress (0-100%)
|
||||||
- Set game status (Pwaying, Compweted, On Howd)
|
- Set game status (Playing, Completed, On Hold)
|
||||||
- Add pewsonal notes fow each game
|
- Add personal notes for each game
|
||||||
- Beautifuw dawk mode UI with puwple accent
|
- Beautiful dark mode UI with purple accent
|
||||||
|
|
||||||
## Technologies Used 🛠️
|
## Technologies Used 🛠️
|
||||||
|
|
||||||
- Python 3.12
|
- Python 3.12
|
||||||
- Flask web fwamework
|
- Flask web framework
|
||||||
- SQLite database
|
- SQLite database
|
||||||
- IGDB API
|
- IGDB API
|
||||||
- HTML, CSS, and JavaScript
|
- HTML, CSS, and JavaScript
|
||||||
- Fwask-SQLAwchemy ORM
|
- Flask-SQLAlchemy ORM
|
||||||
- Responsibe design
|
- Responsive design
|
||||||
|
|
||||||
## Setup Instructions 🚀
|
## Setup Instructions 🚀
|
||||||
|
|
||||||
### 1. Cweate an IGDB API Account
|
### 1. Create an IGDB API Account
|
||||||
|
|
||||||
You need to get API cwedentwials from IGDB:
|
You need to get API credentials from IGDB:
|
||||||
|
|
||||||
1. Go to [Twitch Developer Portal](https://dev.twitch.tv/console/apps/create)
|
1. Go to [Twitch Developer Portal](https://dev.twitch.tv/console/apps/create)
|
||||||
2. Wegistew a new appwication
|
2. Register a new application
|
||||||
3. Get youw Cwient ID and Cwient Secwet
|
3. Get your Client ID and Client Secret
|
||||||
4. Add them to the `.env` fiwe:
|
4. Add them to the `.env` file:
|
||||||
|
|
||||||
```
|
```
|
||||||
IGDB_CLIENT_ID=your_client_id_here
|
IGDB_CLIENT_ID=your_client_id_here
|
||||||
IGDB_CLIENT_SECRET=your_client_secret_here
|
IGDB_CLIENT_SECRET=your_client_secret_here
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. Instaww Dependencwies
|
### 2. Install Dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Activate the viwtuaw enviwonment
|
# Activate the virtual environment
|
||||||
source venv/bin/activate
|
source venv/bin/activate
|
||||||
|
|
||||||
# Instaww all wequired packages
|
# Install all required packages
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Wun the Appwication
|
### 3. Run the Application
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Make suwe you'we in the pwoject woot with viwtuaw enviwonment activated
|
# Make sure you're in the project root with virtual environment activated
|
||||||
python run.py
|
python run.py
|
||||||
```
|
```
|
||||||
|
|
||||||
The app wiww be avaiwable at `http://127.0.0.1:5000/`
|
The app will be available at `http://127.0.0.1:5000/`
|
||||||
|
|
||||||
## Scweenshots 📷
|
## Screenshots 📷
|
||||||
|
|
||||||
(Add scweenshots when avaiwable~)
|
(Add screenshots when available)
|
||||||
|
|
||||||
## Futuwe Enhancements 🌟
|
## Future Enhancements 🌟
|
||||||
|
|
||||||
- User authentication
|
- User authentication
|
||||||
- Supppowt fow twacking mowe than 5 games
|
- Support for tracking more than 5 games
|
||||||
- Game compwetion statistics
|
- Game completion statistics
|
||||||
- Integwation with othew gaming pwatforms
|
- Integration with other gaming platforms
|
||||||
- Achievements fow compweting games
|
- Achievements for completing games
|
||||||
- Timew/twacking fow time spent pwaying
|
- Timer/tracking for time spent playing
|
||||||
- Expowt/impowt game wists
|
- Export/import game lists
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Made with wove and Fwask! (。・ω・。)
|
Made with Flask
|
||||||
|
|||||||
Reference in New Issue
Block a user