Skip to content
/ sample-v2 Public template

Sample - The template project for fast, simple, easy creating a web-site-app based on MVC & RESTful API

License

Notifications You must be signed in to change notification settings

vic4key/sample-v2

Repository files navigation

Sample

Introduction

Sample is a template project for fast, simple, easy creating a web-site-app based on MVC Design Pattern & RESTful API

License

Under the MIT license

Keywords for features

Keywords for demo

  • Sign In / Sign Out to access protected APIs
  • Protected User APIs - Create/Get/Update/Delete
  • Test User APIs via Swagger UI

Requirements

PHP 5.6 or greater

Installation

  1. Make sure Apache & MySQL service is running on your machine
  2. Clone the project to localhost directory as a root-level /
  3. Import the database file at /database.sql to your MySQL
  4. Disable/Enable or define social network integration information at /socials/defines.php (opt - disabled as default)
  5. Okay. Take a look the home page at localhost, the demo page at localhost/demo, the basic account for testing is test:123 or you can using your social network account

Note:

To change the base path / to another such as a sub-level eg. /example we have to make the following changes:

  1. Open the commons/defines.php file and update the variable $SUB_PATH to /example
  2. Open the demo.swagger.yaml file and update the variable basePath to /example
  3. Open the frontend\Sample.bsdesign project and go to Export > Export Settings then update Export Destination and Export Script to the correspond path

The demo files are started with the prefix demo.* and these are deletable eg. demo.content.php, demo.swagger.js, etc

Contact

Feel free to contact via Twitter or Email or Website

Screenshots