https://github.com/luigiminardi/gamingchatphp

A LFG (Looking For Group) platform REST API made with laravel.
https://github.com/luigiminardi/gamingchatphp

api-rest laravel mysql php rest-api

Last synced: 2 months ago
JSON representation

A LFG (Looking For Group) platform REST API made with laravel.

• Host: GitHub
• URL: https://github.com/luigiminardi/gamingchatphp
• Owner: luigiMinardi
• License: mit
• Created: 2022-04-10T12:40:59.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-04-19T19:26:46.000Z (about 3 years ago)
• Last Synced: 2025-10-22T15:18:23.535Z (8 months ago)
• Topics: api-rest, laravel, mysql, php, rest-api
• Language: PHP
• Homepage: https://lug-php.herokuapp.com/api
• Size: 297 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Gaming Chat with PHP



![License](https://img.shields.io/github/license/luigiMinardi/movieClubBackend?style=for-the-badge)

![Laravel](https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white)

![PHP](https://img.shields.io/badge/PHP-777BB4?style=for-the-badge&logo=php&logoColor=white)

![Mysql](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge&logo=mysql&logoColor=white)

![JsonWebToken](https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=JSON%20web%20tokens&logoColor=white)

![Composer](https://img.shields.io/badge/Composer-885630?style=for-the-badge&logo=Composer&logoColor=white)



This is a REST API of a gaming LFG platform, using mysql as data base. Having tables for `games`, `members` and `messages`, `parties`, `users`.



[![Documentation](https://img.shields.io/badge/go%20to-documentation-informational?style=for-the-badge)](https://github.com/luigiMinardi/GamingChatPHP/wiki)



## Installing

* First clone the repository:

    ```bash

    git clone https://github.com/luigiMinardi/GamingChatPHP

    ```

    Enter in the cloned repo `cd GamingChatPHP` or open in your IDE, for example `code GamingChatPHP` if you're using VSC.

* Install all the dependencies:

    ```bash

    composer install

    ```

* Create the data base:

    **You need to have mysql installed and running on your computer for this to work**. You need to create the db directly on mysql (or your GUI manager for SQL dbs).

* Make the migrations:

    ```bash

    php artisan migrate

    ```

* Run the server:

    ```bash

    php artisan serve

    ```

### Configuring .env

In your root repository duplicate the `.env.example` file and rename it to be just `.env`, there you need to eddit these variables with your data:

```m

APP_KEY=

DB_DATABASE=laravel

DB_USERNAME=root

DB_PASSWORD=

```

Run `php artisan jwt:secret` to create the `JWT_SECRET` variable at your `.env`.

Now you are ready to use it.

# Using the API

## Data Base ER Diagram

![ER Draw](./.github/assets/img/laravelBackend.png)

### Expected Behaviour

`created_at`, `update_at`, `id`, are obligatory and auto-generated.

the `id` is the **Primary Key** of the tables.

USER `email` is unique.

GAME `title` is unique.

`user_id`, `game_id` and `party_id` are the USER, GAME and the PARTY **Foreign Key** respectively.

You may see references for the **Primary Key** as `pk` and for the **foreign key** as `fk`.

## Endpoints

To see the endpoints and how they works, check our [documentation](https://github.com/luigiMinardi/GamingChatPHP/wiki).



[![Documentation](https://img.shields.io/badge/go%20to-documentation-informational?style=for-the-badge)](https://github.com/luigiMinardi/GamingChatPHP/wiki)