Skip to content

gabbyTI/shawarma-jungle-api

Repository files navigation

The Shawarma Jungle Ecommerce API

A Laravel based API that exposes endpoints for an e-commerce application. Click here for the Postman documentation of this application.

Dependencies

Before you get started, you need to install

Docker Desktop.

Composer.

Initial Setup

Clone the project from github by running the following command

git clone https://github.com/gabbyTI/shawarma-jungle-api.git

Running Locally

From inside the shawarma-jungle-api folder run the following command.

composer run project-setup-development

Now, to run the project in a docker environment, run the following command.

docker-compose up -d

The first time you run the above command it takes a few minutes, but subsequent runs are quick.

Once the application's Docker containers have been started, you can access the application in your web browser at: http://localhost:6066.

Running database migrations

Before running the migrations, make sure you have started the docker container by running the command in the previous step.

To run the migrations, run the following command.

docker exec shawarma_jungle-php php artisan migrate

API Documentation

View the API documentation at http://localhost:6066/docs.

Emails

View emails on mailhog here: http://localhost:8025.

PhpMyAdmin

View the database with phpmyadmin dashboard: http://localhost:8081

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages