https://github.com/solaimanb/game-library-api
https://github.com/solaimanb/game-library-api
api crud-api fastapi game-library render sqlite
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/solaimanb/game-library-api
- Owner: solaimanb
- Created: 2024-11-21T08:15:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-23T09:10:19.000Z (over 1 year ago)
- Last Synced: 2025-03-24T04:59:21.032Z (over 1 year ago)
- Topics: api, crud-api, fastapi, game-library, render, sqlite
- Language: Python
- Homepage: https://game-library-api-srv.vercel.app
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Game Library API
A full-stack application for managing and displaying video game collections.
### Frontend Features
- Responsive grid layout of game cards
- Real-time game information display
- Clean and modern UI with dark mode support
- Type-safe development with TypeScript
### Backend Features
- Complete CRUD operations for game entries
- Robust data validation with Pydantic
- SQLite database integration
- Interactive API documentation
## Tech Stack
### Frontend
- Next.js
- TailwindCSS
- TypeScript
- Custom React Hooks
### Backend
- FastAPI
- SQLAlchemy
- Pydantic
- SQLite
## Getting Started
### Frontend Setup
1. Install dependencies:
```bash
npm install
```
## Backend Setup Guide
Welcome to the Game Library API! This guide will help you get up and running quickly.
### Quick Start
1. Clone Repository
```bash
git clone https://github.com/solaimanb/game-library-api.git
```
2. Set Up Virtual Environment
```bash
python -m venv venv
```
3. Activate Virtual Environment
- On Windows:
```bash
venv\Scripts\activate
```
- On macOS and Linux:
```bash
source venv/bin/activate
```
4. Install Dependencies
```bash
pip install -r requirements.txt
```
5. Launch Server
```bash
uvicorn app.main:app --reload
```
### Using the API
- Interactive API documentation: http://localhost:8000/docs
- API endpoints available at http://localhost:8000/api/v1/
- Supports full CRUD operations for game entries
### Key Features
- ✨ Modern FastAPI framework
- 📦 SQLite database integration
- ✅ Pydantic data validation
- 🔄 SQLAlchemy ORM
- 📚 Interactive Swagger documentation
### Next Steps
- Visit the API documentation
- Create your first game entry
- Explore the available endpoints
- Start building with the API