https://github.com/jekabsilkens/tone-forge-guitars

Guitar eCommerce website | Laravel | React | Inertia | MySQL | Stripe API
https://github.com/jekabsilkens/tone-forge-guitars

ecommerce inertia javascript laravel mysql php react stripe tailwind

Last synced: 8 days ago
JSON representation

Guitar eCommerce website | Laravel | React | Inertia | MySQL | Stripe API

• Host: GitHub
• URL: https://github.com/jekabsilkens/tone-forge-guitars
• Owner: JekabsIlkens
• Created: 2024-11-15T18:37:00.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-12-01T13:02:02.000Z (2 months ago)
• Last Synced: 2024-12-01T13:20:31.583Z (2 months ago)
• Topics: ecommerce, inertia, javascript, laravel, mysql, php, react, stripe, tailwind
• Language: PHP
• Homepage:
• Size: 24.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    



## Table of Contents

**[Development Notes](#development-notes)**


**[Installation Instructions](#installation-instructions)**


**[User Journey Showcase](#user-journey-showcase)**


## Development Notes

**Tech Stack:** Laravel + React + Inertia + MySQL + Tailwind + Stripe API

**To-Do List:**

- [x] Refactor messy routing to better comply with RESTful

- [x] Shipping address details for customers before purchase

- [ ] Admin panel for managing products and active orders

- [ ] Stripe Webhook listener to correctly track order status

- [ ] Ability to update cart item quantity on cart page

## Installation Instructions:

### Ensure you have the following installed:

- PHP (version 8.2 or later)

- Composer (for PHP dependencies)

- Symfony CLI (for serving over https)

- Node/npm (for frontend dependencies and asset building)

- MySQL or PostgreSQL (for a local database server)

### Clone the repository on your local machine and step into the project directory:

```shell

git clone https://github.com/JekabsIlkens/tone-forge-guitars.git

cd tone-forge-guitars

```

### Open .env.example, add your Stripe API test keys and local database credentials:

```shell

STRIPE_KEY=public_key_test

STRIPE_SECRET=secret_key_test

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=your_database_name

DB_USERNAME=your_database_user

DB_PASSWORD=your_database_password

```

### Run the setup script to install dependencies and prepare the database:

```shell

setup.bat

```

### Run the start script to launch the local development server:

```shell

start.bat

```

### If you encounter any issues execute these commands manually in the specified order:

```shell

copy .env.example .env              # Creates the environment configuration file

composer install                    # Installs the required PHP dependencies

npm install                         # Installs the required front-end dependencies

npm run build                       # Builds the required front-end assets

php artisan key:generate            # Generates the application key

php artisan migrate:fresh           # Runs the database migrations

php artisan db:seed                 # Seeds the database

npm run dev                         # Starts the Vite development server

symfony serve                       # Starts the Symfony server

```

## User Journey Showcase:

**Note:** may not represent current state (depends on how often I update these)