pet-shop's Introduction

Pet Shop

This repository contains APIs for the Pet Shop (eCommerce). The project uses docker compose to minimise the setup process. Each directory in the project signifies a single function and is mounted in the appropriate containers.

Directory Structure

build/ directory

The build directory contains instructions for building a container. It provides us with a logical separation of build steps.

config/ directory

The config directory contains configuration attached to containers. It helps us to persist the configuration even when the containers are rebooted.

data/ directory

The data directory contains container related data. It helps us to persist the application specific data even when the containers are rebooted.

repository/ directory

The repository directory will contain the Laravel application.

Note: Please note that this docker setup should only be used for development purposes and by no means should be deployed to production.

System requirements

Docker
Docker Compose
Port 80 should be available for Nginx
Port 3306 should be available for MySQL

Infrastructure

Nginx
PHP 8.2
MySQL 8.1
Laravel 10

Continuous Integration

Laravel Tests
Larastan Static Code Analysis

Setup Guide

1. Clone the repository to your local folder

2. Run with docker-compose

Execute the below command:

docker-compose exec up -d

3. Connect to the container for further setup

docker-compose exec php8 bash

4. Copy .env.example to .env

cp .env.example .env

5. Run Composer Install

composer install

6. Generate Application Keys

php artisan key:generate

Keys for JWT can be generated using:

php artisan jwt:keys

7. Run Migrations

php artisan migrate

8. Choose your localhost or virtual host configuration.

Localhost: http://localhost

Virtual Host: http://api.pet-shop.test

Note: Please make sure the host file has the correct entry.

Thank you!

Recommend Projects

siddhantfriends / pet-shop Goto Github PK