Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisbbreuer/ecommerce
https://github.com/chrisbbreuer/ecommerce
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/chrisbbreuer/ecommerce
- Owner: chrisbbreuer
- Created: 2023-02-14T05:38:19.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-14T06:04:08.000Z (almost 2 years ago)
- Last Synced: 2024-10-19T17:57:07.086Z (2 months ago)
- Language: PHP
- Size: 503 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FluxBucket — Challenge
This is a simple application that takes orders from listed products. It is built with Laravel, Vue 3 & Inertia.
## 🚧 Prerequisites
Given this project requires only a default Laravel install, I have opted out of using Laravel Sail _(Docker)_ in favor of a more lightweight "setup" approach. This means you'll need to have the following installed on your machine:
- Any PHP 8 version _(e.g. 8.2.2)_
- Composer 2 _(e.g. 2.5.3)_
- Node 16 or 18 _(project is nvm ready)_
## 🚀 Get Started
To get started, you'll need to clone this repository and run the commands below:
```bash
# Step 1: Run the setup script
#
# The setup command is a custom script that...
#
# 1. installs Laravel dependencies
# 2. copies the .env.example to .env
# 3. generates your local encryption key
# 4. creates the SQLite database file
# 5. runs the migrations
# 6. seeds the database with some dummy data
# 7. installs the "frontend dependencies"
#
#
#
npm run setup
# Step 2: Serve the application
#
# Use the "artisan serve" command to
# serve the app on port 8000.
#
php artisan serve --port 8000
# Optional: Install the frontend dependencies
#
# You may skip this step unless you prefer using `pnpm`
# or `yarn`. _(I personally prefer pnpm the most 🙂)_
#
npm install
# Step 3: Run the frontend development server
#
# The frontend is built with Vue 3 & Inertia.
# To run the development server, run the
# command below:
#
npm run dev
nvm use 18 # you may use nvm to manage your Node version
```
### Login Credentials
Here are the 2 users available for login
```
Username: [email protected]
Password: password
Username: [email protected]
Password: password
```
### Demo
Here's a quick demo of the application in action.
### ER Diagram
Below is this code challenge's Entity Relationship diagram.
## 📖 Testing
You can run the test suite by running the command below:
```bash
php artisan test
```
The output will look similar to this:
