Skip to content

Latest commit

 

History

History
96 lines (73 loc) · 4.19 KB

README.md

File metadata and controls

96 lines (73 loc) · 4.19 KB

About Application    |    Technologies    |    How to Run    |    Routes    |    Project Status    |    License


Stars Forks License

About Application

The Scrim Games project's backend application is meticulously constructed with PHP and the Laravel framework. During the development phase of Scrim Games, we harnessed the capabilities of state-of-the-art libraries from both React and Laravel. This synergy guarantees a contemporary user experience and empowers the platform with resilient functionalities, elevating the engagement and effective management of documented gaming sessions.

Furthermore, the Scrim Games API employs JSON Web Token authentication to meticulously validate its users.

Technologies

PHP logo image. Laravel logo image. PostgreSQL logo image. Swagger logo image. Heroku logo image. Docker logo image.

How to Run

First, start by cloning the repository:

git clone https://github.com/shunny2/scrim-games-api

If you use docker, run the following command from the project root directory to build and run the project.

docker-compose up --build

Now that you are inside the container, run the command below to install all dependencies.

composer install

And finally, access the project URL: Welcome

Routes

The image below describes the routes available by the application.

routes

API Documentation is available at /api/v1/docs

Project Status

Status: Completed.

License

This project is under an MIT license.


Created by Alexander Davis.