/Shop-Inventory-With-JWT

Primary LanguagePHP

Certainly! Below is a sample content for a readme.md file for a repository about a simple inventory system using modern architecture of frontend using axios and JavaScript, and backend as Laravel API with features like category, product, order, report, PDF invoice. JWT is used for token authorization, and it is a multi-user application.

# Shop Inventory System with JWT Authentication

Welcome to the Shop Inventory System, a simple yet powerful application for managing your store's inventory. This project is built with modern frontend technologies using Axios and JavaScript, while the backend is developed with Laravel API. JWT (JSON Web Tokens) is used for secure token-based authentication, ensuring a multi-user environment.

## Features

1. **Category Management**: Organize products into different categories for better inventory management.

2. **Product Management**: Add, edit, and delete products, including details such as name, price, and quantity.

3. **Order Tracking**: Manage orders, track their status, and update order information as needed.

4. **Reporting**: Generate comprehensive reports to analyze product sales, stock levels, and other vital statistics.

5. **PDF Invoice Generation**: Automatically generate PDF invoices for orders, providing a professional touch to your transactions.

## Technologies Used

- **Frontend**:
  - JavaScript
  - Axios for API communication
  
- **Backend**:
  - Laravel API
  
- **Authentication**:
  - JWT (JSON Web Tokens) for secure user authentication

## Getting Started

1. Clone the repository:
   ```bash
   git clone https://github.com/seo-asif/Shop-Inventory-With-JWT.git
   cd Shop-Inventory-With-JWT

  1. Install dependencies:

    composer install

  2. Configure the environment:

    • Set up your database configuration in the .env file in the directory.
    • Configure other necessary settings such as JWT secret key "JWT_KEY".

  3. Run migrations and seed the database:

    # Inside the backend directory
php artisan migrate --seed

  4. Start the application:

    php artisan serve

  5. Access the application in your browser: http://localhost:8000

Contributing

Contributions are welcome! Please follow the contribution guidelines when submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.


Make sure to replace placeholders like `your_database_configuration`, `your_jwt_secret_key`, and others with the actual configuration values from your project. Also, update the `CONTRIBUTING.md` and `LICENSE` files accordingly.