In this intensive workshop we will set up a mobile-first web application with all the good and state of the art parts. Let's have a look to the latest stable AngularJS version, HTML5, LESS and Twitter Bootstrap. Everything is built up on NodeJS with Gulp and Webpack.
At the end of the workshop you have a stable code base to build your own ideas.
Peter is Senior JavaScript Engineer & JavaScript Evangelist at the HOTEL DE GmbH in Nuremberg. He gives talks at meetups and conferences and organizes the local JavaScript meetup FrankenJS.
Create a projects folder
Create a new folder for your projects - for example projects at C:\ or in your home directory on Unix machines ~/projects.
Download the zipped project
https://github.com/hotelde/in-vision-day-workshop-2016/archive/master.zip
Download the zipped source and extract it to your projects folder. You will finally have projects/in-vision-day-workshop-2016/.
Terminal or Shell
On Linux and OSX open the terminal. On Windows machines you can open cmd.exe (Start > run > cmd.exe) or any other available shell you want.
Switch to the projects/in-vision-day-workshop-2016 folder.
Example on Windows:
cd C:\projects\in-vision-day-workshop-2016
Example on Unix:
cd ~/projects/in-vision-day-workshop-2016
Install all Dependencies
Now install all dependencies by running the command below.
npm install
This may take awhile.
To start coding we have to run our development server. In this technology stack we use webpack to build and serve our project.
npm run dev
Run the command above to start the webpack development server. After a few seconds it spawns our application at http://localhost:8080
Open the browser of your choice (but Google Chrome is recommended :)) and navigate to the URL.
If everything went well you should see our shiny new web application.
Google Chrome is an excellent browser for web development. Open the developer tools (on Windows and Linux press F12; on OSX press alt + command + i) and go into device mode.
Open the device mode
Select any device - for example iPhone 6
Now our web application will appear in the shiny mobile-first design.
api/ # contains some JSON files to simulate our API
app/ # All application components are in here
dist/ # Contains the final application, tested and built
gulp/ # Taks for development, testing and build
node_modules/ # All dependencies installed via NPM
.Gulpfile.js # This file serves all gulp tasks
index.html # Entry point of our web application
package.json # Defines our project and dependencies
README.md # Contains all information to set up the project
webpack.config.js # Configuration file for webpack
Our web application is built with components. This is a common way in modern web development to structure code and apps. Hence each element can be defined in a separate folder.
app/ # Contains the initial application module
app/header/ # The application header
app/hotel/ # A component to represent a hotel
app/menu/ # The menu
app/pages/ # A component which handles our pages
app/pages/404/ # The 404 page if a requested page does not exist
app/pages/hotels/ # A list of hotels
app/pages/index/ # The start page
The application is built on AngularJS 1.5.3. Angular dependencies must be defined in modules. This makes it easy to provide re-usable code. An angular module is defined by a unique name. Since we have a clear folder structure, we can reuse the path for name spacing / module naming.
Have a look at the code below how a angular module will be defined according to the file path.
// app/app.js
angular.module('app', [
// Dependencies / other module names
'app.pages'
]);Let's have a look at a nested components
// app/pages/pages.js
angular.module('app.pages', [
// Dependencies / other module names
'app.pages.index',
'app.pages.hotels',
'app.pages.404'
])//app/pages/404/404.js
angular.module('app.pages.404', [
// This module has no dependencies
]);Each component matches on a HTML tag - for example <menu>, <hotel> or <header>.
An Angular module can have any components. But it's not a must. The app.pages module does not have a component, but it's required to load the requested page (/hotels => <hotels>).
The image below shows how the components are nested at the application. The HTML markup is completely independent from the file path / namespace.
First you can start with any task you want to. The tasks are independent from each other. All tasks and needed changes are available as a GIT diff with a bunch of comments to help you out.
Create a new page with a custom route, add it to the menu and style it. What about a disclaimer page?
We still have a list of hotels but no detailed information about the offer. Hence we need a new page to show more information for a specific hotel.
Each hotel can be identified by a unique ID which makes it possible to address the data via these kind of URL: /hotel/1 (/hotel/:hotelId)
At the moment we offer 10 different hotels. Some of them are bad rated so we should provide a simple way for you customers to order from the best to the worst. So let's create a new icon in the header area which orders the hotels by tapping on it.
JSON (JavaScript Object Notation) is a syntax schema to define JavaScript objects. It's a common way to deal with JSON API's (Application Interfaces). Our sample app makes a simple HTTP request on /api/hotels.json and uses this data to represent the content. Feel free to add some new hotels, modify the data or try to change the JSON structure and see what will happen :)
This step is quite easy. Just run the command below:
npm run build
... and boom! Our tooling pipeline builds the application for us. All resources which are defined in our /app are now bundled and compress and can be found in /dist.
This result could be deployed to any web server.
If you are looking for a new challenge, join us!
Follow the link below for the slides of the opening presentation
https://www.icloud.com/keynote/000eHdbPhyK0nzafwKyL1zFIQ#Modern_Web_Development