Dveloper Manual

Code access:

The source code is available in the [code directory] (../.).

Project License

This code is an open-source, under the copy-rights - Team, 'Paleta publishing'. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistribution of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistribution in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANT ABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Project code components:

As we work with MEAN stack methodology the components are:

• Mongo DB
• Express
• Angular
• NodeJs

In addition our code contains:

• HTML
• CSS
• Java Script / JQuery
• BootStrap

Directory structure & files in the project:

In the meanwhile, these are the directories and files that we have in the project:

• Client - include all files of client side:

  • controllers - This directory contains all the java script files.
  • views - This directory contains all the HTML files.
  • css - This directory contains all the css files - the style sheets.
  • src - This directory contains impotred files that we used in the project like classes of bootstrap and angular.
  • app.js - The main java script file of the project.

• index.html - The main HTML file of the project.

• package.json - This file presents the impotred code packages that are needed to run this application.

Compiling & Running:

Using Azure - App engine, or just run it on a web browser starting with index.html page.

Debugging & Checking:

Debugging both client/server sides within the browser the application is running on. Pree F12 to follow the errors occure during run time.