Nectar Documentation
DemoBuy Now
  • Introduction
  • Getting Started
    • Requirements
    • Installation
    • Directory Structure
    • Dependencies & Plugins
  • Basics
    • Configuration
    • Routes
    • Layout
    • Navigation
    • Initialization
    • Theming
    • Internationalization
    • Store Management
  • UI & UX
    • Components
      • Accordion
      • Action Sheet
      • Audio
      • Autocomplete
      • Badge
      • Breadcrumb
      • Button
      • Card
      • Chart
      • Checkbox
      • Chip
      • Color Picker
      • Content Block
      • Data Table
      • Date-Time Picker
      • Dialog
      • Dropcap
      • Elevation
      • Embed
      • Empty State
      • Expandable Card
      • Flip Card
      • Floating Action Button
      • Form Input
      • Form Validator
      • Gauge
      • Grid
      • Icon
      • Image
      • Image Compare
      • Image Hotspot
      • Infinite Scroll
      • Keypad
      • Line Divider
      • List Index
      • List View
      • Marquee
      • Menu
      • Menu List
      • Navbar
      • Note
      • Notification
      • Pagination
      • Photo Browser
      • Picker
      • Popover
      • Popup
      • Preloader
      • Progress Bar
      • Pull-to-Refresh
      • Quote
      • Radio
      • Range Slider
      • Rating
      • Ribbon
      • Searchbar
      • Sheet Modal
      • Show More/Less
      • Side Panel
      • Signature Pad
      • Skeleton
      • Smart Select
      • Sortable List
      • Stepper
      • Subnavbar
      • Swipeout
      • Swiper Slider
      • Syntax Highlighter
      • Tab
      • Text Editor
      • Timeline
      • Timer
      • Toast
      • Toggle
      • Toolbar
      • Tooltip
      • Tour Guide
      • Tree View
      • Video
      • Virtual List
    • Screens
      • Splash Screen
  • Advanced
    • Web APIs
      • App Badging API
      • App Shortcuts API
      • Battery Status API
      • Clipboard API
      • Contact Picker API
      • Device Memory API
      • Device Orientation API
      • File API
      • Fullscreen API
      • Geolocation API
      • Get Installed Related Apps API
      • HTML Media Capture API
      • Local Storage API
      • Network Information API
      • Notifications API
      • Online & Offline Status API
      • Page Visibility API
      • Permissions API
      • Picture-In-Picture API
      • Quota Estimation API
      • Screen Orientation API
      • Screen Wake Lock API
      • Server-Sent Events API
      • Session Storage API
      • Vibration API
      • Web Share API
    • Cordova Plugins
      • Battery Status
      • Build Info
      • Camera
      • Contacts Info
      • Device
      • Dialogs
      • Fingerprint Authentication
      • Geolocation
      • In-App Browser
      • Media Capture
      • Network Information
      • Social Sharing
      • Splash Screen
      • SQLite
      • Status Bar
      • Vibration
    • Integrations
      • AlaSQL
      • Disqus
      • Embedly
      • Facebook Comments
      • Google AdMob
      • Google Maps
      • Google Sheets
      • Gravatar
      • Lottie
      • Mailchimp
      • QR Code
      • RSS
      • Telegram Comments
      • WordPress
      • YouTube
  • Publishing
    • Progressive Web App
    • Cordova App
  • Help
    • Changelog
    • Support
    • Customization
  • Tutorials
    • How to Create and Animate an SVG Image Using JavaScript
Powered by GitBook
On this page
  • Overview
  • The Root Directory
  • The www Directory
  • The assets Directory
  1. Getting Started

Directory Structure

Overview

The default directory structure is intended to provide a great starting point for both Progressive Web App and Cordova App.

The Root Directory

  • /res This directory contains platform-specific resources such as launch icons, splash screens, configuration and resource files for the Cordova project.

  • /www This directory contains the project's HTML/CSS/JS assets.

  • config.xml It is a global configuration file that controls the Cordova app's behavior.

The www Directory

  • /assets This directory contains the CSS, JS, images, fonts assets etc.

  • /partials This directory contains the HTML files known as partials.

  • index.html This file is the entry point to the app.

  • manifest.json This Web App Manifest is a simple JSON file that tells the browser about your PWA and how it should behave when installed on the user's home screen.

  • service-worker.js This file empowers the PWA by enabling offline caching, push notifications etc.

  • .htaccess This is a configuration file for Apache Web Server.

  • favicon.ico This is a favicon in ICO format.

The assets Directory

The /assets contains two directories — /vendor and /custom

  • The /vendor directory contains the core dependencies, third-party libraries and plugins used in the app.

  • The /custom directory contains the custom assets such as images used in the app, CSS overrides or app-specific JavaScript functions.

The files in the /vendor directory might change with future releases.

Therefore, it is highly advised not to make any changes in CSS or JS files present inside the /vendor directory. If you want to make any changes such as styling then you should override those CSS in custom.css file and put it inside /custom/css directory. The same goes for JavaScript code as well, create a custom.js file and put it inside /custom/js directory.

PreviousInstallationNextDependencies & Plugins

Last updated 2 years ago