From a961c941380b71fb8879c2921f0db6ca24efcc3c Mon Sep 17 00:00:00 2001 From: Efthakhar Date: Sat, 26 Aug 2023 23:01:18 +0600 Subject: [PATCH] Add local server installation process in README.md file --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 56 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9d040df..409f8ef 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,61 @@ Inventory Management System With Laravel & Vue JS ![Open Source Income Expense Tracker](https://raw.githubusercontent.com/efthakhar/invextry/master/public/img/invextry-ss1.png) +# Installation Guide + +Follow these steps to set up and run the project locally. + +### Prerequisites + +Make sure you have the following installed: + +- Git +- Composer +- Node.js and npm +- PHP >= 8.1 +- MySQL + +### Installation Steps + +1. **Clone the GitHub repository** + ```sh + git clone https://github.com/efthakhar/invextry.git +2. **Install Composer packages:** + ```sh + composer install +3. **Install npm packages** + ```sh + npm install +4. **Create .env file:** + Duplicate .env.example and rename it to .env. + +5. **Generate encryption key** + Run the following command to generate a unique application key. + ```sh + php artisan key:generate +6. **Update APP_URL in .env** + Open .env file and update the APP_URL value according to your application's domain path. For local development, it will typically be: + + ```sh + APP_URL=http://127.0.0.1:8000 + +7. **Run migrations** + + ```sh + php artisan migrate + +8. **Start the development server** + + ```sh + php artisan serve + +9. **Enable development mode** + ```sh + npm run dev + +Now you're all set up! Access your application through the specified APP_URL. + + ## Contributor - [Efthakhar Bin Alam](https://github.com/efthakhar). (efthakharbin@gmail.com) @@ -25,6 +80,4 @@ This project wouldn't be possible without the amazing contributions of the follo - [voler](https://github.com/zuramai/voler): Bootstrap5 Admin Template - [apexcharts/vue3-apexcharts](https://github.com/apexcharts/vue3-apexcharts): Vue-3 component for ApexCharts -- [RemixIcon](https://github.com/Remix-Design/RemixIcon): Open source neutral style icon system - - +- [RemixIcon](https://github.com/Remix-Design/RemixIcon): Open source neutral style icon system \ No newline at end of file