alainmucyo / shop-app-backend

The Online Shopping Platform is a robust online store designed to track which items are added to a basket but removed before checkout. This data is beneficial for the sales team to offer targeted discounts. The application is built with Laravel 8 and MySQL.

Online Shopping Platform

The Online Shopping Platform is a robust online store designed to track which items are added to a basket but removed before checkout. This data is beneficial for the sales team to offer targeted discounts. The application is built with Laravel 8 and MySQL.

Getting Started

1. Git clone this repository and cd into the project directory:

git clone https://github.com/alainmucyo/shop-app-backend.git cd shop-app-backend

Pre-requisites

• PHP 8.2 or greater
• Laravel 8
• MySQL
• Composer
• Docker (optional)

Installation

1. Install PHP if you don't have it installed.
2. Install Composer if you don't have it installed.
3. Install MySQL and create a new database for the project.
4. Install Docker and Docker Compose (optional).

Configuring the Application

1. Copy .env.example to .env in the project root: cp .env.example .env
2. Set your database credentials in the .env file.
3. Run composer install to install PHP dependencies.
4. Run php artisan key:generate to generate your application key.
5. Run php artisan migrate to run the database migrations.
6. Run php artisan db:seed to seed the database with test data.

Running the Application

1. Run php artisan serve to start the server. The API will be running at http://localhost:8000.

Running the Tests

1. Set your testing database credentials in the .env.testing file.
2. Run php artisan migrate --env=testing to run the database migrations for testing.
3. Run php artisan test to run the tests.

API Documentation

API doc can be accessed here: https://documenter.getpostman.com/view/11889963/2s93sjUUfw

• Admin user:

• Email: [email protected]

• Password: password

• Role: Allows creation, deletion, and updating of products.

• Sales user:

• Email: [email protected]

• Password: password

• Role: Allows creation of products.

Deployment

The application is designed to be easily deployed to Fly.io. The Dockerfile provided is tailored for Fly.io deployment. Follow the instructions in the official Fly.io documentation.

You can access the deployed application at https://alainmucyo-shop.fly.dev.

Built With

• PHP 8.2
• Laravel 8
• MySQL
• Docker

Authors

• Alain MUCYO - Github Profile

Licence

This software is published under the MIT licence.