https://github.com/weiwei2694/laravel10-restful-api-inventory-system
Restful Api Inventory System: Laravel 10, Eloquent, MySQL
https://github.com/weiwei2694/laravel10-restful-api-inventory-system
eloquent laravel10 mysql
Last synced: 2 months ago
JSON representation
Restful Api Inventory System: Laravel 10, Eloquent, MySQL
- Host: GitHub
- URL: https://github.com/weiwei2694/laravel10-restful-api-inventory-system
- Owner: weiwei2694
- Created: 2024-02-08T02:25:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-10T03:14:26.000Z (about 1 year ago)
- Last Synced: 2025-01-10T10:24:48.215Z (4 months ago)
- Topics: eloquent, laravel10, mysql
- Language: PHP
- Homepage:
- Size: 190 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Restful Api Inventory System: Laravel 10, Eloquent, MySQL
Restful Api Inventory System is a platform designed to help businesses manage their inventory efficiently. With support for managing users, roles, categories, products, orders, and order items, the system allows users to easily add, retrieve, update, and delete inventory data through a responsive and reliable API.
To see the full documentation for this project, you can visit the link below:
- [Documentation](https://app.swaggerhub.com/apis-docs/99ARYAPRIMA/laravel10-restful-api-inventory-system/1.0.0)
This is a Restful Api based Inventory System, if you need a web based one, you can visit the repository below:
- https://github.com/weiwei2694/laravel10-inventory-system
## Key Features
- Roles System
- Categories
- Products
- Orders
- Order Items
- Users
- Crud
- Synchronous Data Between Orders, Order Items and Products
- MySQL
- Unit Testing
- Authentication
- Authorization
- Route Management
- Pagination
- Eloquent
## Cloning the repository
```bash
git clone https://github.com/weiwei2694/laravel10-restful-api-inventory-system.git
cd laravel10-restful-api-inventory-system
```
## Install packages
*package*
```bash
npm install
yarn install
pnpm install
bun install
```
*composer*
```bash
composer install
composer update
```
## Setup .env file
For setting up your environment variables, you can start by copying the `.env.example` file to create your `.env` file. The `.env.example` file typically contains examples or placeholders for the environment variables your application needs. To simplify this process, you can use the following command:
```bash
cp .env.example .env
```
This command will duplicate the `.env.example` file and create a new file named `.env`, allowing you to fill in the actual values for your environment variables.
After creating your `.env` file, ensure that your Laravel application is ready to run smoothly by executing the following command to generate an application key:
```bash
php artisan key:generate
```
This command will generate a unique key for your application, which is essential for security and encryption purposes.
Next, make sure that the database configuration in your .env file points to your MySQL database. Update the `DB_DATABASE`, `DB_USERNAME`, and `DB_PASSWORD` variables with the appropriate values for your MySQL database setup.
To prepare for running unit tests, you should create a separate `.env` file specifically for testing purposes. Copy the contents of your .env file and create a new file named `.env.testing.` In the `.env.testing` file, modify the `DB_DATABASE` variable to a testing database name of your choice, such as `mysql_testing`. This ensures that your unit tests run independently from your main database, preventing any data loss or interference with your production data.
Ensure that both your `.env` and `.env.testing` files are properly configured before proceeding with running your Laravel application or executing unit tests.
## Running Applications
To start your application, make sure to follow the steps below:
1. **Styling with Bootstrap**: Before running the application, ensure you have prepared the styling using Bootstrap. Run the following command to compile your assets:
```bash
npm run dev
```
This will ensure that the user interface of your application is styled properly using Bootstrap.
2. **Starting the Server**: After ensuring the styling has been applied, you can start the Laravel PHP server by running the command:
```bash
php artisan serve
```
Make sure to run the command in a separate terminal. This will start your local development server and make your application accessible through your web browser.
By following these steps, you can start running your application and access it through your web browser for further development. Happy exploring and developing your application!