Skip to content

Latest commit

 

History

History
77 lines (63 loc) · 2.73 KB

README.md

File metadata and controls

77 lines (63 loc) · 2.73 KB
Raw

Hypermedia project

  • Claudio Cardinale
  • Giorgio Pea

Demo site

How to use

How to configure

  1. Create a mysql database and an user with write acces to it
  2. Import DB/dbschema.sql
  3. Set server address on
    • WEBSITE/resources/views/includes/config.jade
    • WEBSITE/resources/assets/js/app.js
  4. Create config.php file using example on config directory

How to compile

  1. type npm install
  2. type gulp

Note: all actions must be executed in the WEBSITE directory

How to test locally

type gulp serve

Note: all actions must be executed in the WEBSITE directory

How to use with apache

  • Set WEBSITE/public as the root directory
  • Give the permissions to php to execute files in WEBSITE (so not only WEBSITE/public)

Files structure

  • DB/db.sql mysql export with schema and data
  • WEBSITE/public/
    • 'Compiled' html files
    • js/app.js our js and libraries joined together in one js file
    • img all images slitted in dynamic and static
    • css/app-less.css css 'compiled' by less, it contains only libraries (like bootstrap)
    • css/app-sass.css css 'compiled' by sass, it contains only our css
    • files files downloadable in the site
    • api php backend for db
  • WEBSITE/config/config.php mysql parameters configuration, example configuration on WEBSITE/config/config.example.php
  • WEBSITE/resources/
    • assets/
      • js it contains ES6 source files written by us, without any library. They are compiled together, with libraries, into app.js.
      • less it contains less files, used only to import css libraries. They are compiled together, with libraries, into app-less.css.
      • sass it contains sass files written by us, without any libraries. They are compiled together into app-sass.css.
    • php it contains useful php files imported by API and other useful scripts like fakeData.php
    • views it contains pug (ex jade) templates used to generate HTML, it is divided in include and public directories. Only public directory files are converted as single HTML pages. they are compiled into public directory as html files

External reosurces

Frameworks

Libraries

All libraries are npm libraries

  • babel-preset-es2015
  • babel-preset-react
  • gulp-print
  • gulp-rename
  • gulp-shell
  • jquery-stickytabs
  • laravel-elixir
  • laravel-elixir-pug
  • query-string
  • vue-resource

Notes

  • It is projected to be used with apache, since we use .httaccess