{"id":20734257,"url":"https://github.com/hafizn07/epic-rpg-api","last_synced_at":"2025-03-11T10:43:30.135Z","repository":{"id":204624845,"uuid":"711960937","full_name":"hafizn07/Epic-RPG-API","owner":"hafizn07","description":"This repository houses the Epic-RPG Backend API, a feature-rich web API built with .NET 7 and C#. It powers the Epic-RPG game, allowing users to manage characters, skills, weapons, and engage in epic battles. Explore a robust set of endpoints for game management. ","archived":false,"fork":false,"pushed_at":"2023-11-07T14:59:26.000Z","size":69,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-18T00:49:15.852Z","etag":null,"topics":["backend-api","csharp","dotnet7","rpg-game","webapi"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hafizn07.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-10-30T14:18:10.000Z","updated_at":"2023-12-24T20:23:49.000Z","dependencies_parsed_at":"2023-11-07T15:52:32.183Z","dependency_job_id":null,"html_url":"https://github.com/hafizn07/Epic-RPG-API","commit_stats":null,"previous_names":["hafizmp/epic-rpg-api","hafizn07/epic-rpg-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hafizn07%2FEpic-RPG-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hafizn07%2FEpic-RPG-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hafizn07%2FEpic-RPG-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hafizn07%2FEpic-RPG-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hafizn07","download_url":"https://codeload.github.com/hafizn07/Epic-RPG-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243020180,"owners_count":20222971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend-api","csharp","dotnet7","rpg-game","webapi"],"created_at":"2024-11-17T05:29:26.007Z","updated_at":"2025-03-11T10:43:30.112Z","avatar_url":"https://github.com/hafizn07.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Epic-RPG Backend API Documentation\n\nWelcome to the Epic-RPG Backend API documentation. This API is the backbone of an RPG game and allows you to perform various actions and interactions within the game.\n\n![Epic-RPG Logo](https://phx02pap003files.storage.live.com/y4mshUUqW6nBDGMTO-d11k3hpFn-Qyj2x7zppV2f3SKztgzEAGOrIhX9dBu-2MjGGg9Ur2ZtYoZYgnt7sZZZehHwBw3Y68qSdQv448an27ewn_Vzx7X-RKG8cwOLVUNgCanvA32_lKygeJ9pSxYH_CWBcPVVFAJwXb3KMZWRCd8FumrvOsT94cC6_CwSnyhrKrJeoRPshFVMUNdePvLzisJ6Ym0P4bLrVvInAqs6V8dWxk?encodeFailures=1\u0026width=500\u0026height=500)\n\n## Table of Contents\n\n1. [Introduction](#introduction)\n2. [Getting Started](#getting-started)\n   - [Prerequisites](#prerequisites)\n   - [Installation](#installation)\n3. [Endpoints](#endpoints)\n   - [Authentication](#authentication)\n   - [Character Management](#character-management)\n   - [Fight](#fight)\n   - [Weapon](#weapon)\n4. [Database](#database)\n   - [Entities and Relationships](#entities-and-relationships)\n   - [Data Seeding](#data-seeding)\n5. [Authentication and Authorization](#authentication-and-authorization)\n   - [JSON Web Tokens (JWT)](#json-web-tokens-jwt)\n   - [User Registration](#user-registration)\n   - [User Login](#user-login)\n6. [Project Structure](#project-structure)\n   - [Solution Overview](#solution-overview)\n   - [Commit History](#commit-history)\n7. [Contributing](#contributing)\n\n## Introduction\n\nThe Epic-RPG Backend API is built using .NET 7 and C# Web API. It provides the functionality for managing user accounts, character creation and management, skills, weapons, and combat in the Epic-RPG game.\n\n## Getting Started\n\n### Prerequisites\n\n- .NET 7\n- Entity Framework\n- SQL Server or other compatible database\n- Git\n\n### Installation\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/hafizmp/Epic-RPG-API.git\n```\n\n2. Navigate to the project directory and set up the database connection string.\n\n3. Run the following command to create the database and apply migrations:\n\n```bash\ndotnet ef database update\n```\n\n4. Start the API:\n\n```bash\ndotnet watch run\n```\n\nThe API will be accessible at `http://localhost:5200/`\n\n## Endpoints\n\n### Authentication\n\n- __POST__  `/api/Auth/Register` : User registration.\n- __POST__  `/api/Auth/Login` : User login to obtain a JWT token.\n\n### Character Management\n\n- __GET__  `/api/Character/GetAll` : Get all characters.\n- __GET__  `/api/Character/{id}` : Get a specific character.\n- __DELETE__  `/api/Character/{id}` : Delete a specific character.\n- __POST__  `/api/Character` : Create a new character.\n- __PUT__  `/api/Character` : Update a character.\n- __POST__  `/api/Character/Skill` : Manage skills for a character.\n\n### Fight\n\n- __POST__  `/api/Fight/Weapon` : Use a weapon during a fight.\n- __POST__  `/api/Fight/Skill` : Use a skill during a fight.\n- __POST__  `/api/Fight` : Begin a fight.\n- __GET__  `/api/Fight` : Get information about an ongoing fight.\n\n### Weapon\n\n- __POST__  `/api/Weapon` : Create a new weapon.\n\n![Epic-RPG endpoints](https://phx02pap003files.storage.live.com/y4m3oDsC4pnVebeLl1KUC671xzPidQb9iFn_yP92FbqE0ssupz93184PMmJIbol-vFeN2VvdKVgVI-wx7GwgbOSIWohmDuvpU7l3DfZ__vRafrPQLqdEbrau_1RGq6ptm9-GOUan1w30qBUM0IjR8MtGssVSt5bll42vzU615UCG-QTg_ObtGbsOrbLcQIOXj6DgQv_yaYPWe9P2n1nZuGx9PSa3WLYEjkoNJPonJBnHSc?encodeFailures=1\u0026width=1748\u0026height=1240)\n\n## Database\n\n### Entities and Relationships\n\nThe API uses Entity Framework to manage the following entities and their relationships:\n\n- Users\n- Characters\n- Skills\n- Weapons\n\n### Data Seeding\n\nThe database is seeded with initial data to demonstrate the API's functionality.\n\n## Authentication and Authorization\n\n### JSON Web Tokens (JWT)\n\nThis API uses JWT for authentication and authorization.\n\n### User Registration\n\nUsers can register using the `/api/Auth/Register` endpoint.\n\n### User Login\n\nUsers can obtain an access token by logging in via the `/api/Auth/Login` endpoint.\n\n## Project Structure\n\n### Solution Overview\n\n- `EpicRPG.API` : The main API project.\n- `EpicRPG.Data` : Data models and Entity Framework setup.\n- `EpicRPG.Services` : Business logic and services.\n- `EpicRPG.Auth` : Authentication services.\n- `EpicRPG.DTOs` : Data transfer objects.\n- `EpicRPG.Controllers` : API controllers.\n\n## Commit History\n\nHere are some of the key commits that contributed to the development of the API:\n\n- Find commits by clicking here - [Epic-RPG-API commits](https://github.com/hafizmp/Epic-RPG-API/commits/main)\n\n## Contributing\n\nFeel free to contribute to the development of Epic-RPG-API by submitting pull requests or reporting issues.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhafizn07%2Fepic-rpg-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhafizn07%2Fepic-rpg-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhafizn07%2Fepic-rpg-api/lists"}