-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add local server installation process in README.md file
- Loading branch information
Showing
1 changed file
with
56 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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]) | ||
|
@@ -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 |