Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nabilshadman/flask-gamemanage-app-prototype

A prototype of a web application to collect your games in one place, search for new games, and connect with other gamers
https://github.com/nabilshadman/flask-gamemanage-app-prototype

flask full-stack game-management software-engineering web-application

Last synced: 8 days ago
JSON representation

A prototype of a web application to collect your games in one place, search for new games, and connect with other gamers

Awesome Lists containing this project

README

        

# GameManage: Personal Gaming Collection Platform

![Python](https://img.shields.io/badge/python-3.9+-blue.svg)
![Flask](https://img.shields.io/badge/flask-%23000.svg?style=flat&logo=flask&logoColor=white)
![Bootstrap](https://img.shields.io/badge/bootstrap-%23563D7C.svg?style=flat&logo=bootstrap&logoColor=white)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=flat&logo=html5&logoColor=white)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![GCP](https://img.shields.io/badge/Google_Cloud-4285F4?style=flat&logo=google-cloud&logoColor=white)
![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=flat&logo=github&logoColor=white)

## 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](https://pacific-destiny-391109.ue.r.appspot.com/).

## 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](https://github.com/nabilshadman/flask-gamemanage-app-prototype/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
- Python 3.9 or higher ([Download](https://www.python.org/downloads/))

#### Platform-Specific Installation Guides
- [Linux Installation Guide](https://docs.python-guide.org/starting/install3/linux/)
- [macOS Installation Guide](https://python.tutorials24x7.com/blog/how-to-install-python-3-9-on-mac)
- [Windows Installation Guide](https://www.ics.uci.edu/~pattis/common/handouts/pythoneclipsejava/python.html)

### Getting Started

1. Clone the Repository
```bash
# SSH
git clone [email protected]: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
```

2. Set Up Virtual Environment
```bash
# 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
```

3. Install Dependencies
```bash
# Install Flask
pip install Flask

# Install project dependencies
pip install -r requirements.txt
```

4. Launch Application
```bash
# 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](https://flask.palletsprojects.com/en/2.0.x/quickstart/).

### Contributing
When adding new dependencies, please update the requirements file:
```bash
pip freeze > requirements.txt
```

## Additional Resources
- [Flask Installation Guide](https://flask.palletsprojects.com/en/2.0.x/installation/)
- [Flask Quickstart Guide](https://flask.palletsprojects.com/en/2.0.x/quickstart/)

## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE.txt) file for details.

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

```bibtex
@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}
}