Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform...

45
1 Astervander Technical Document Table Of Content Introduction Softwares and Frameworks used PHP Codeigniter HTML CSS Javascript Ionic2 Angular2 Apache Cordova Nodejs Android Studio Xcode Web Application : Configuration Explanation of Modules Explanation of Codes Mobile Application: Confiuguration Explanation of Modules Explanation of Codes

Transcript of Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform...

Page 1: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

1

Astervander Technical Document

Table Of Content

Introduction

Softwares and Frameworks used

PHP

Codeigniter

HTML

CSS

Javascript

Ionic2

Angular2

Apache Cordova

Nodejs

Android Studio

Xcode

Web Application :

Configuration

Explanation of Modules

Explanation of Codes

Mobile Application:

Confiuguration

Explanation of Modules

Explanation of Codes

Page 2: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

2

Introduction

This application helps shops to host advertisements for their products. The seller can

directly chat with the customer and promote his product. This app is a meeting place for the

seller and the buyer, thereby increasing sales for the seller and on the other hand the buyer

gets a genuine product directly from the seller because of which he is benefitted in terms of

price also. This document clearly explains each module and functionality of each module.

Software and Frameworks Used

PHP

- PHP is a server-side scripting language designed primarily for web

development but also used as a general-purpose programming language

Codeigniter

- CodeIgniter is a powerful PHP framework with a very small footprint, built

for developers who need a simple and elegant toolkit to create full-featured

web applications

HTML

- Hypertext Markup Language (HTML) is the standard markup language for

creating web pages and web applications. With Cascading Style Sheets (CSS)

and JavaScript it forms a triad of cornerstone technologies for the World

Wide Web. Web browsers receive HTML documents from a webserver or

from local storage and render them into multimedia web pages. HTML

describes the structure of a web page semantically and originally included

cues for the appearance of the document

CSS

- Cascading Style Sheets (CSS) is a style sheet language used for describing

the presentation of a document written in a markup language. Although

most often used to set the visual style of web pages and user interfaces

written in HTML

Javascript

- JavaScript® (often shortened to JS) is a lightweight, interpreted, object-

oriented language with first-class functions, and is best known as the

Page 3: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

3

scripting language for Web pages, but it's used in many non-browser

environments as well. It is a prototype-based, multi-paradigm scripting

language that is dynamic, and supports object-oriented, imperative, and

functional programming styles

Ionic2

- Ionic2 is a complete open-source SDK for hybrid mobile app development.

Built on top of Angular2 and Apache Cordova, Ionic2 provides tools and

services for developing hybrid mobile apps using Web technologies

like CSS, HTML5, and Sass. Apps can be built with these Web technologies

and then distributed through native app stores to be installed on devices by

leveraging Cordova

Angular2

- Angular 2 is an open source JavaScript framework to build web applications

in HTML and JavaScript and has been conceived as a mobile first approach

Apache Cordova

- Apache Cordova is an open-source mobile development framework. It

allows you to use standard web technologies - HTML5, CSS3, and JavaScript

for cross-platform development. Applications execute within wrappers

targeted to each platform, and rely on standards-compliant API bindings to

access each device's capabilities such as sensors, data, network status, etc

Nodejs

- Node.js is an open-source, cross-platform JavaScript runtime

environment for developing a diverse variety of server tools and applications.

Although Node.js is not a JavaScript framework, many of its basic modules

are written in JavaScript, and developers can write new modules in

JavaScript. The runtime environment interprets JavaScript

using Google's V8 JavaScript engine

Android Studio

- Android Studio is the official IDE for android application development

Xcode

Page 4: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

4

- Xcode is an integrated development environment for macOS containing a

suite of software development tools developed by Apple for developing

software for macOS, iOS, watchOS and tvOS

Web Application

Configuration

- Change the url for the web application in config.php

- Add database details in database.php

Page 5: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

5

Explanation of Modules

Authentication Module has Auth and Verifylogin controllers, User_model model.

This module helps an user to login the page.

- The screenshot images will clearly explain each functionality

Controllers

Auth Controller

File name: auth.php

Path: application/controllers This is a authentication controller and it contains login page and

forget password page functionally

Page 6: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

6

Verifylogin Controller

File name: verifylogin.php

Path: application/controllers

This is a Verifylogin controller ,it contains Login page, Forget

Password page, Signup pageand Change Password page functionally

Page 7: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

7

Home Controller

File name: home.php

Path: application/controllers This is a Home controller ,it contains home page functionally

Model

User Model

File name: user_model.php

Path: application/model

Page 8: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

8

Category Module has Category controllers, Category model. This module helps

an user to create, edit, and view the category.

The screenshot images will clearly explain each functionality

Controllers

Category Controller

File name: category.php

Path: application/controllers

This is a category controller and it contains create, edit and view

page functionally

Page 9: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

9

Model

Category Model

File name: category_model.php

Path: application/model

Page 10: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

10

SubCategory Module has SubCategory controllers, SubCategory model. This

module helps an user to create, edit, and view the subcategory.

The screenshot images will clearly explain each functionality

Controllers

SubCategory Controller

File name: subcategory.php

Path: application/controllers

This is a subcategory controller and it contains create, edit and

view page functionally

Page 11: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

11

Model

SubCategory Model

File name: subcategory_model.php

Path: application/model

Page 12: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

12

Color Module has Color controllers, Color model. This module helps an user to

create, edit, and view the Color.

The screenshot images will clearly explain each functionality

Controllers

Color Controller

File name: color.php

Path: application/controllers

This is a Color controller and it contains create, edit and view page

functionally

Page 13: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

13

Size Module has Size controllers, Size model. This module helps an user to

create, edit, and view the Size.

The screenshot images will clearly explain each functionality

Controllers

Size Controller

File name: size.php

Path: application/controllers

This is a Size controller and it contains create, edit and view page

functionally

Page 14: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

14

Model

Size Model

File name: size_model.php

Path: application/model

Page 15: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

15

Shop Module has Shop controllers, Shop model. This module helps an user to

create, edit, and view the Shop.

The screenshot images will clearly explain each functionality

Controllers

Shop Controller

File name: shop.php

Path: application/controllers

This is a Shop controller and it contains create, edit and view page

functionally

Page 16: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

16

Model

Shop Model

File name: shop_model.php

Path: application/model

Page 17: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

17

Product Module has Product controllers, Product model. This module helps an

user to create, edit, and view the Product.

The screenshot images will clearly explain each functionality

Controllers

Product Controller

File name: product.php

Path: application/controllers

This is a Product controller and it contains create, edit and view

page functionally

Page 18: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

18

Model

Product Model

File name: product_model.php

Path: application/model

Page 19: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

19

Plan Module has Plan controllers, Plan model. This module helps an user to

create, edit, and view the Plan.

The screenshot images will clearly explain each functionality

Controllers

Plan Controller

File name: plan.php

Path: application/controllers

This is a Product controller and it contains create, edit and view

page functionally

Page 20: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

20

Model

Plan Model

File name: plan_model.php

Path: application/model

Page 21: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

21

Payment Module has Payment controllers, Payment model. This module helps

an user to create, edit, and view the Payment.

The screenshot images will clearly explain each functionality

Controllers

Payment Controller

File name: payment.php

Path: application/controllers

This is a Payment controller and it contains create, edit and view

page functionally

Page 22: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

22

Activation Module has Activation controllers, Activation model. This module

helps an user to create, edit, and view the Activation.

The screenshot images will clearly explain each functionality

Controllers

Activation Controller

File name: activaion.php

Path: application/controllers

This is a Payment controller and it contains create, edit and view

page functionally

Page 23: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

23

Model

Activation Model

File name: activation_model.php

Path: application/model

Page 24: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

24

Chat Module has Chat controllers, Chat model. This module helps an user to

create, edit, and view the Chat.

The screenshot images will clearly explain each functionality

Controllers

Chat Controller

File name: chat.php

Path: application/controllers

This is a Chat controller and it contains create, edit and view page

functionally

Model

Chat Model

File name: chat_model.php

Path: application/model

Page 25: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

25

Mobile Application

Configuration

- Change the application name and version of the mobile application in

config.xml

Page 26: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

26

Explanation of Modules

Authentication:

o The screenshot images will clearly explain each functionality

Path: src/pages/login

This is a authentication module and it contains login with user

credentials, login with Facebook and forgot password functionally. login.ts

contains functionality, login.html contains html and login.scss contains css of

login page,

Home Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/home

This is a home module and it displays the newly added products

linked to each category and displays the list of categories available on the

application. home.ts contains functionality, home.html contains html and

home.scss contains css of home page,

Page 27: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

27

Product Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/product This is a product module and it displays the products by

corresponding category. product.ts contains functionality, product.html contains

html and product.scss contains css of product page,

Page 28: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

28

Product-view Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/product-view

This is a product-view module and it displays the product description

by corresponding product. product-view.ts contains functionality, product-

view.html contains html and product-view.scss contains css of product-view

page,

Shop Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/shop

This is a shop module and it displays the products by corresponding

shops. shop.ts contains functionality, shop.html contains html and shop.scss

contains css of shop page,

Page 29: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

29

Search Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/search

This is a search module and it displays the products by

corresponding searchs. search.ts contains functionality, search.html contains

html and search.scss contains css of search page,

Page 30: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

30

Chat List Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/chatlist

This is a chatlist module and it displays the chatlist. chatlist.ts

contains functionality, chatlist.html contains html and chatlist.scss contains css

of chatlist page,

Chat Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/chat

This is a chat module and it displays the message list by

corresponding chat. chat.ts contains functionality, chat.html contains html and

chat.scss contains css of chat page,

Page 31: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

31

Account details Module:

- The screenshot images will clearly explain each functionality

Path: src/pages/accountdetail

This is a chat module and it displays the customer account details.

accountdetail.ts contains functionality, accountdetail.html contains html and

accountdetail.scss contains css of accountdetail page,

Page 32: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

32

Account Module:

- The screenshot images will clearly explain each functionality

Page: Account

Path: src/pages/account

This is a account module and it is for edit account details. account.ts

contains functionality, account.html contains html and account.scss contains

css of account page,

Page: Change password

Path: src/pages/changepassword

This is a account module and this page for change the password.

changepassword.ts contains functionality, changepassword.html contains the

HTML and changepassword.scss contains css of account page,

Page 33: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

33

Page 34: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

34

AsterVander Mobile Application

AsterVander is a mobile application used for shopping various needs of customer. Let us

see the various parts of the application along with its screen explanations.

Splash Screen:

This is the loading page of the application.

Page 35: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

35

Login Page:

Existing customers can login to the application using their username and password.

New customers can sign-up for creating an account.

Customers can also sign-up using their facebook account.

Page 36: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

36

Home Page:

Displays the newly added products linked to each category.

Page 37: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

37

Category Page:

Displays the list of categories available on the application.

Page 38: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

38

Sub-category Page:

Displays the list of sub-parts available under each category.

Page 39: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

39

Search:

This field allows customers to search for the item they need.

Page 40: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

40

View:

Customers can adjust the views of displaying products of their own i.e. list, tiles.

Page 41: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

41

Sort:

Users can also sort the items based on the rate either from low to high (or) high to low.

Page 42: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

42

Product Details:

Once the product/item has been selected, the below page will appear. It will show all the

details of the product/item, seller info etc.

Page 43: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

43

User Account Page:

This page the details of the user such as Name, email id, contact details, etc.

Users are also allowed to reset their password if they want.

Page 44: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

44

Chat:

This feature allows users to chat live with the shop owners to enquire about the product

informations.

Page 45: Astervander Technical Document Table Of Content · -Node.js is an open-source, cross-platform JavaScript runtime environment for developing a diverse variety of server tools and applications.

45