Skip to content

Latest commit

 

History

History
124 lines (96 loc) · 4.32 KB

README.md

File metadata and controls

124 lines (96 loc) · 4.32 KB

GameManage: Personal Gaming Collection Platform

Python Flask Bootstrap HTML5 License: MIT GCP GitHub

Overview

GameManage is a full-stack web application that serves as your centralized gaming hub, allowing you to manage your game collection, discover new titles, and connect with fellow gamers. Experience the live prototype here.

Platform Preview

GameManage Homepage Carousel

Homepage featuring an interactive game carousel

GameManage Featured Games

Featured games section showcasing popular titles

Technology Stack

  • Backend: Python/Flask
  • Frontend: HTML, Bootstrap
  • Development: GitLab, GitHub
  • Deployment: Google Cloud Platform (formerly Heroku)
  • Design: Lucidchart, Figma

Documentation

Comprehensive documentation covering requirements, design, planning, implementation, testing, and review is available in our project wiki. Note that the repository and wiki have been migrated from GitLab to GitHub, and deployment has transitioned to Google Cloud Platform.

Local Development Setup

Prerequisites

Platform-Specific Installation Guides

Getting Started

  1. Clone the Repository
# SSH
git clone git@github.com:nabilshadman/flask-gamemanage-app-prototype.git

# or HTTPS
git clone https://github.com/nabilshadman/flask-gamemanage-app-prototype.git

# Navigate to project directory
cd gamemanage-app-prototype
  1. Set Up Virtual Environment
# Create virtual environment
# Linux/macOS
python3 -m venv venv

# Windows
py -3 -m venv venv

# Activate virtual environment
# Linux/macOS
source venv/bin/activate

# Windows
venv\Scripts\activate
  1. Install Dependencies
# Install Flask
pip install Flask

# Install project dependencies
pip install -r requirements.txt
  1. Launch Application
# Linux/macOS
export FLASK_APP=app
flask run

# Windows PowerShell
$env:FLASK_APP = "app"
flask run

For detailed Flask configuration and running options, consult the Flask Documentation.

Contributing

When adding new dependencies, please update the requirements file:

pip freeze > requirements.txt

Additional Resources

License

This project is licensed under the MIT License. See the LICENSE file for details.

Citation

If you use this work in your research, please cite:

@misc{gamemanage-app,
  author = {Shadman, Nabil and Chan, Tom},
  title = {GameManage: Personal Gaming Collection Platform},
  year = {2021},
  publisher = {GitHub},
  url = {https://github.com/nabilshadman/flask-gamemanage-app-prototype}
}