TOC

• About
• Use
• Documentation
• Testing
• Issues

Proof of concept mobile web-app for market product sales tracking.

Registers actual products being sold, as well as the time (stored in the DB). This information is crucial for sellers to figure out the best times at a market vs. those times that could be spent better doing something else.

This is the tech and skill demo version withour real application data like products. Early, conceptual MVP phase with some features to be refined and finished on demand.

Install Node and Composer on local system.

• Composer
• Node.js

Then run in CLI:

composer install
npm install

• Install a PHP server and database that can run the API's PHP code
  • Copy credentials template from _internals
  • Adjust path to credentials under public/api/index
  • Initialize the database with SQL from _internals/sql/*.sql
• Run the build and upload the build folder
  • Build contains the API that needs PHP and SQL to run

• Create file .env with content from env.example (adjust as needed)
• See info about htpasswd settings to adjust depending on hosting environment.

Be aware that running DEV server vs running build scripts use different environments. Build is for production only.

# Start DEV server (with hot reload)
# - Uses development path config
npm run start

# Build production bundle for deployment
# - Uses '.env.production' file and different paths
npm run build

# Start LIVE server preview (static files)
# - Intended to be used with production build only
npm run run

See: composer.json, package.json

For security reasons: Package versions have been made static without upgrade possibility. If you need to update within the current major version, add the ^ symbol in front of version numbers.

• .htaccess: Update path under AuthUserFile
• .htpasswd: See secret values in .env.example

Any system and app configuration.

• Backend
  • URLs: /public/api/config/*.php
  • Routes: .../api/app/request/routes.php
• Frontend
  • Environment: .env*
  • URLs: /src/config/*.ts

Path eventually without /public/

• JSON: /public/api/data/products.json

To use image placeholder, remove the img attribute from a product in productList. Any given path will try to load the image, even if thaht is a 404.

Application dependencies for feature development and production.

Not in use (yet) - Frontend or backend.

Specific settings that diverge from expected default setups.

Generally important to know.

Important React concepts:

• Props, State, Component lifecycle
• Hooks: useEffect, useState

Checklist for QA purposes.

If the application shows a broken interface, it's likely a failed PHP call to the API returning weird data; e.g. /api/?method=price returns path instead data. In this case the server/ PHP version is not compatible to the application.

This will lead to merge conflicts over time. It's solely included to simplify a minimalist one-way workflow, and to keep a safe running artifact independent from any NPM hickups, when re-installing the app after a while.

• Where: Browser console, message
• When: Sometimes on code change and DEV env rebuild
• Solution: Reload website manually