initial commit
This commit is contained in:
75
README.md
Normal file
75
README.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# Game Twacker 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~
|
||||
|
||||
## Featuwes ✨
|
||||
|
||||
- Seawch fow games thwough the IGDB API
|
||||
- Twack up to 5 games you'we cuwwently pwaying
|
||||
- Update game pwogwess (0-100%)
|
||||
- Set game status (Pwaying, Compweted, On Howd)
|
||||
- Add pewsonal notes fow each game
|
||||
- Beautifuw dawk mode UI with puwple accent
|
||||
|
||||
## Technologies Used 🛠️
|
||||
|
||||
- Python 3.12
|
||||
- Flask web fwamework
|
||||
- SQLite database
|
||||
- IGDB API
|
||||
- HTML, CSS, and JavaScript
|
||||
- Fwask-SQLAwchemy ORM
|
||||
- Responsibe design
|
||||
|
||||
## Setup Instructions 🚀
|
||||
|
||||
### 1. Cweate an IGDB API Account
|
||||
|
||||
You need to get API cwedentwials from IGDB:
|
||||
|
||||
1. Go to [Twitch Developer Portal](https://dev.twitch.tv/console/apps/create)
|
||||
2. Wegistew a new appwication
|
||||
3. Get youw Cwient ID and Cwient Secwet
|
||||
4. Add them to the `.env` fiwe:
|
||||
|
||||
```
|
||||
IGDB_CLIENT_ID=your_client_id_here
|
||||
IGDB_CLIENT_SECRET=your_client_secret_here
|
||||
```
|
||||
|
||||
### 2. Instaww Dependencwies
|
||||
|
||||
```bash
|
||||
# Activate the viwtuaw enviwonment
|
||||
source venv/bin/activate
|
||||
|
||||
# Instaww all wequired packages
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### 3. Wun the Appwication
|
||||
|
||||
```bash
|
||||
# Make suwe you'we in the pwoject woot with viwtuaw enviwonment activated
|
||||
python run.py
|
||||
```
|
||||
|
||||
The app wiww be avaiwable at `http://127.0.0.1:5000/`
|
||||
|
||||
## Scweenshots 📷
|
||||
|
||||
(Add scweenshots when avaiwable~)
|
||||
|
||||
## Futuwe Enhancements 🌟
|
||||
|
||||
- User authentication
|
||||
- Supppowt fow twacking mowe than 5 games
|
||||
- Game compwetion statistics
|
||||
- Integwation with othew gaming pwatforms
|
||||
- Achievements fow compweting games
|
||||
- Timew/twacking fow time spent pwaying
|
||||
- Expowt/impowt game wists
|
||||
|
||||
---
|
||||
|
||||
Made with wove and Fwask! (。・ω・。)
|
||||
Reference in New Issue
Block a user