Skip to content

Latest commit

 

History

History
executable file
·
205 lines (142 loc) · 8.63 KB

README.md

File metadata and controls

executable file
·
205 lines (142 loc) · 8.63 KB
Raw

GDG Kozhikode Website - Frontend

This is the frontend part of GDG kozhikode website build with Google's Material Design Lite(MDL) & Web Starter Kit.

Features

  • Responsive & work well across different device screen size
  • Works as Progressive Web App(PWA)
  • Can save to homescreen & offline capability

Note:

The MDL supporting files are loaded from cloud, so the site might won't paint the right way on the browser when try it offline.

Table of contents

  1. Quick Start
  2. Prerequisites
  3. Get the Code
  4. Run the Project
  5. Build & Optimize
  6. File Structure
  7. Contribution

Quick Start top

  • Clone the repository
$ git clone https://github.com/GDGKozhikode/gdg_website.git
  • Install dependencies inside the folder
$ cd gdg_website
$ npm install

This will install npm packages for the development

  • Run the website in browser
$ gulp serve

Gulp will create two additional folders (.tmp/ & dist/).
It from the dist/ folder the site is servered. It has all the .css, .js & index.html files in minfied form.

Prerequisites top

Node.js

Type node --version in your terminal to check if Node is installed. Terminal will respond with a version at or above 0.10.x, if installed. If not installed (or need to upgrade), go to nodejs.org and click on the big green Install button.

Gulp

Type gulp --version in your terminal to check if Gulp is installed. Terminal will return a version number at or above 3.9.x, if installed. To install/upgrade Gulp, open up a terminal and type in the following:

$ npm install --global gulp

This will install Gulp globally. Depending on your user account, you may need to configure your system to install packages globally without administrative privileges.

Get the code top

Download / Clone the repo.

Open the download/cloned folder in your terminal.

$ cd ../gdg_website

Local dependencies

Install the local dependencies that are requires:

$ npm install

Run the project top

$ gulp serve

This outputs an IP address you can use to locally test and another that can be used on devices connected to your network. serve does not use service worker caching, so your site will stop being available when the web server stops running.

Hot reload is in-built, so watch For changes & automatically refresh across devices everytime you save changes in the file(s).

Build & Optimize top

$ gulp

Build and optimize the current project, ready for deployment. This includes linting as well as image, script, stylesheet and HTML optimization and minification. Also, a service worker script will be automatically generated, which will take care of precaching your sites' resources. On browsers that support service workers, the site will be loaded directly from the service worker cache, bypassing the server. This means that this version of the site will work when the server isn't running or when there is no network connectivity.

Serve the Fully Built & Optimized Site

$ gulp serve:dist

This outputs an IP address you can use to locally test and another that can be used on devices connected to your network. serve:dist includes will serve a local copy of the built and optimized site generated as part of the default task. Because the optimized site includes a service worker which serves your site directly from the cache, you will need to reload the page after regenerating the site to pick up the latest changes. serve:dist uses a different HTTP port than serve, which means that the service workers are kept isolated in different scopes.

Difference Between serve & serve:dist

It is important to note a difference between the serve and serve:dist tasks.

  • serve uses a no-op service-worker.js and cannot run offline.
  • serve:dist uses the sw-precache-generated output and can run offline.

The serve task runs on port 3000 and serve:dist runs on port 3001. The main purpose is to ensure that different service workers will not impact each other's environment. Using the sw-precache-generated output makes it very difficult to quickly test local changes which is not ideal for a development server environment.

Performance Insights

$ gulp pagespeed

Runs the deployed (public) version of your site against the PageSpeed Insights API to help you stay on top of where you can improve.

File Structure top

app/index.html

This the main html file.

app/images/

This is where all image files reside.

app/scripts/

This is where the JavaScript files reside.

app/styles/

This is where the custom CSS files are. You can place any *.scss you wish to have & gulp task will compile it into *.css in the styles directory.
Renaming main.css to main.scss will cause the file to treat as Sass.

app/manifest.json

manifest.json contains a Web Application Manifest - a simple JSON file that gives you the ability to control how your app appears to the user in the areas that they would expect to see apps (for example the mobile home screen). In here you can control what the user can launch and more importantly how they can launch it.

app/manifest.webapp

manifest.webapp refers to the proprietary Firefox OS manifest format, and not the W3C manifest spec, designed for cross-browser open web applications.

The Firefox OS app manifest provides information about an app (such as name, author, icon, and description) and a list of Web APIs that your app needs.

app/service-worker.js

A service worker is a script that is run by your browser in the background, separate from a web page, opening the door to features such as offline support.

app/humans.txt

File that contains information about the different people who have contributed to building the website.Read More

app/robots.txt

Instructions about the site to web robots.Read More

.babelrc

.babelrc is a configuration file for passing options to Babel - the ES2015 transpiler recommended for writing next-generation JavaScript.

.editorconfig

EditorConfig is a file format and collection of text editor plugins for maintaining consistent coding styles between different editors and IDEs.

.gitignore

Contain files & folders for git to avoid tracking such as Node Modules, .tmp/, dist/ etc.

gulpfile.babel.js

Gulp is a streaming build system that allows you to automate tedious development tasks. Compared with other build systems, such as Grunt, gulp uses Node.js streams as a means to automate tasks, thereby removing the need to create intermediate files when transforming source files.

In gulp, you would install plugins, that do one thing and do it well, and construct a 'pipeline' by connecting them to each other. A gulpfile allows you to put together tasks that use plugins to accomplish a task like minification.

gulpfile.babel.js is a gulpfile written in ES2015. The babel portion of the name refers to its use of the Babel transpiler for enabling ES2015 code to run there.

README.md

This is the file your reading now ;). Written in Markdown language.

CONTRIBUTING.md

Open the file to see how to participate & contribute to the project.