Marketplace Demo repository

The source for the marketplace demo repo hosted at https://github.com/tompenzer/marketplace-demo. This is a demonstration of a marketplace where users can add stores and list products with them, and users can purchase those products. This project has a Laravel 5.7-based back-end API with MySQL and Redis for data storage, a React/Redux front-end with Passport-implemented OAuth2 authentication, and Docker managing the dev environment.

The front-end design is inspired by the https://github.com/mithunjmistry/ecommerce-React-Redux-Laravel project, though little of its code remains intact; most aspects of the front-end architecture have been refactored or rewritten, and the back-end only shares a few lines of code.

Installation

Development environment requirements:

• Git - on Mac, you will be prompted to install the CLI dev tools including git upon attempting to git clone in the command below if you don't already have it installed.
• Docker - On Mac, you can download the installer directly without needing a Docker account here. For Windows, it's available here.
• Selenium Server - for feature tests.
  • A web browser for Selenium-based automated feature testing. By default, Chrome is required to run the Selenium feature tests, but you can configure any preferred browser per the instructions below.
  • If sticking with Chrome, you'll need the Chrome webdriver executable for your OS present in the /usr/local/bin directory.

Detour - configuring Selenium-Server - skip if you don't need feature tests

For efficiency of resource usage, we're going to configure Selenium, the web browser automation tool used to run our feature tests, so that the Docker container host (your main OS environment) runs the Selenium Server, using local web browsers running on the host, thus avoiding the need for an extra Docker image with a full windowing system needed to run its own browser(s).

On Mac, you can use Homebrew to install Selenium Server as such:

$ brew install selenium-server-standalone

To have launchd start selenium-server-standalone now and restart at login:

$ brew services start selenium-server-standalone

Or, if you don't want/need a background service you can just run:

$ selenium-server -port 4444

The .env.testing file is currently configured with the SELENIUM_HOST set to host.docker.internal, which should route to the Docker container host on all platforms. This can be changed if you'd rather connect to a different Selenium Server host.

All feature tests are configured to run using a single web browser, currently set to Chrome. If you prefer using a different Selenium test browser, you can modify the SELENIUM_BROWSER key in the .env.testing file. Note that most feature tests appear unsuccessful with the Firefox/gecko Selenium webdriver, so tread carefully when switching browsers.

End of detour

Clone the repo and start up the development environment using the terminal on your local machine:

$ git clone [email protected]:tompenzer/marketplace-demo.git
$ cd marketplace-demo
$ ./startup.sh

The commands run by the startup.sh script might be useful to run individually as needed, so I'll copy them here for reference:

$ cp .env.example .env
$ docker-compose run --rm --no-deps marketplace-server composer install
$ docker-compose run --rm --no-deps marketplace-server php artisan key:generate
$ docker-compose up -d
$ docker-compose run --rm node-server yarn install
$ docker-compose run --rm node-server yarn run dev
$ docker-compose run --rm marketplace-server php artisan migrate --seed
$ docker-compose run --rm marketplace-server php artisan passport:install
$ docker-compose run --rm marketplace-server ./vendor/bin/phpunit

Note - potential sql error

If you get a DB PDO error at the end of the startup process, try connecting to the docker mysql image server with any SQL client (i.e. Sequel Pro if you're on a Mac), with the following credentials:

host: 0.0.0.0
port: 3306
user: root
pass: secret

And then try running the database migrations manually:

$ docker-compose run --rm marketplace-server php artisan migrate --seed

This will create the default admin user that you can use to sign in.

Usage

The dev env site should be accessible in your web browser at the following URL:

http://localhost:8000

You can register your own user account, or use the default admin account credentials to log in:

Email: [email protected]
Password: admin

Testing

To run the testing suite, run the following command:

$ docker-compose run --rm marketplace-server ./vendor/bin/phpunit

These tests are run automatically at the end of the startup.sh script.

Note that these tests run in their own testing data storage (DB, Redis) environment, including the Selenium-driven browser integration tests. The bootstrap/app.php script is configured to load the testing environment when requests are made on port 8080, as is the case for all such testing.

Stopping the dev environment

To have docker take down the server container, wipe the built docker images, and erase the database cache, ensuring a fresh build next time, run the following command from inside the project directory:

$ docker-compose down
$ rm -rf storage/tmp/db

Production build

If you pass the word production as an argument to startup.sh, it'll build the front-end in production mode and skip DB migrations when initializing the environment:

$ ./startup.sh production

If you've already got the development environment running, you can skip the environment startup and directly run the production front-end build with the following command:

$ docker-compose run --rm node-server yarn run prod

Cleaning up Docker remnants

After running docker-compose down and shutting down this environment, Docker will leave a lot of cached data in various obscure parts of the filesystem, using up your storage. To get Docker to purge ALL THE THINGS, run the following commands:

$ docker system prune -a
$ docker volume rm $(docker volume ls -qf dangling=true)

License

The Marketplace Demo project is open-sourced software licensed under the MIT license.