marketplacekit/marketplacekit

Open source Marketplace Platform

1.0.1-beta 2018-10-02 12:26 UTC

README

68747470733a2f2f6d61726b6574706c6163652d6b69742e73332e616d617a6f6e6177732e636f6d2f6c6f676f2e706e67

About MarketplaceKit

MarketplaceKit is a platform for building different types of online marketplaces. MarketplaceKit attempts to reduce the development effort required to build product, rental, service and listing marketplaces such as Etsy, AirBnB, Handy and Zillow. It does this by attempting to cover the main components a marketplace needs, including the following:

  • Powerful search across multiple fields, geolocation and custom fields
  • Geolocalization for users and listings
  • Frontend listing creation and browsing
  • User profiles
  • Direct messaging between users
  • Multilingual functionality

68747470733a2f2f6d61726b6574706c6163652d6b69742e73332e616d617a6f6e6177732e636f6d2f707265766965772e706e67

MarketplaceKit uses popular, well documented packages without too much overhead to simplify a developers/designers life. Therefore, the following choices were made:

  • Based on the popular Laravel Framework
  • Leverages Bootstrap 4 for a responsive and mobile-first theme out of the box
  • Separates theming logic from development by using Twig
  • Avoids JS frameworks that require compilation
  • Uses different widgets for different listing types (coming soon)

MarketplaceKit is easy to customize, change the design and supports multiple languages.

Server Requirements

  • PHP 7.2
    • OpenSSL PHP Extension
    • PDO PHP Extension
    • Mbstring PHP Extension
    • Tokenizer PHP Extension
    • XML PHP Extension
    • Ctype PHP Extension
    • JSON PHP Extension
    • ImageMagick PHP Extension
  • MySQL 5.7.7 or greater
  • Node JS (8.9.4) - this is only required for compiling SCSS to CSS
  • Git
  • ImageMagick
  • Nginx

Although MarketplaceKit has been tested on Ubuntu 16.04 LTS. It should work with any OS that satisfies the above requirements. Nginx (https://laravel.com/docs/5.6/deployment#nginx) is recommended as a webserver. Developers should also have knowledge of Laravel, Bootstrap and Twig for extending/building on top of MarketplaceKit.

Installation

  • Download the code via composer

     composer create-project marketplacekit/marketplacekit:dev-master marketplacekit
    
  • Add your database details to the .env file

    DB_CONNECTION=mysql
    DB_HOST=127.0.0.1
    DB_PORT=3306
    DB_DATABASE=homestead
    DB_USERNAME=homestead
    DB_PASSWORD=secret
    
  • Create the public disk

    php artisan storage:link
    
  • Create the database tables by running

    php artisan migrate
    
  • Seed the database by running

    php artisan db:seed
    
  • Configure your Nginx server block or Apache Vhost to point to the /public folder

    e.g. nginx

    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }
    

    e.g. apache

    Options +FollowSymLinks
    RewriteEngine On
    
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule ^ index.php [L]
    
  • Visit your domain login and change the default password

    Default username: admin
    Default password: changeme
    
  • Add your domain to APP_URL in .env file

    APP_URL=http://localhost.com
    

    Don't forget to add https:// in production.

  • Install the node modules (Optional)

    npm install
    

Facebook login

In order for your users to login via Facebook you need to register for a Facebook key.

Google Maps Keys

MarketplaceKit relies on Google Maps for geolocalized searches. Please visit https://developers.google.com/maps/documentation/javascript/get-api-key to generate your key. You can then add this in the admin panel.

Updating

To update MarketplaceKit please run:

git pull origin master

and to install any new packages

composer update

API (Note: Work in progress)

For authentication: POST /api/auth/login [email, password] GET /api/auth/me GET /api/auth/refresh

For all other requests please use the same URLs as the website but use use "Accept: application/json" in the HTTP headers. This will convert all data passed to HTML into JSON. e.g. POST /register GET /browse GET /listing//

License

MarketplaceKit is free software, and is released under the terms of the GPL version 3. See license.txt.