Skip to content

Commit

Permalink
Add local server installation process in README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
efthakhar committed Aug 26, 2023
1 parent 0ff552b commit a961c94
Showing 1 changed file with 56 additions and 3 deletions.
59 changes: 56 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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). ([email protected])
Expand All @@ -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

0 comments on commit a961c94

Please sign in to comment.