Warning
This project is no longer maintained. Only there for code reference. It contains multiple security issues in dependecies.
A CMS to upload posters of Vimeo movies and show them on a screen.
The Amsterdam University of Applied Sciences needs an application for displaying posters on screens. They are using A0 posters now. But there are not enough places for all students to show their poster. Now they have asked to create a CMS for uploading the posters and display them in a slideshow
Download: https://github.com/mat1th/screens-CMS.git
Go to the project:
cd path/to/filesInstall node modules:
npm installBefore you can start the application you need to connect to the database. Also you need to setup the mail configuration of the application.
Please duplicate config/config_example.json and rename the file to config/config.json. In this file you define all the passwords of the app and the database connections. The variables in the all section are available in each environment.
An example setting block:
"development": {
"env": "development",
"dbOptions": {
"host": "host",
"user": "user",
"password": "ww",
"database": "database",
"port": 10000
}
}You can create as much environments as you want. To use a stage duplicate config/config_example.js and rename the file to config/config.js. This file will be used for selecting the environment. Replace the string on the first line with the environment you want to use.
var env = process.env.NODE_ENV || 'development'Now we have to set up the database connection. In the file database/database.sql you can find the database structure. Please add it to your database. Now you can build the app.
Install Gulp:
npm install --global gulp-cliGo to the project:
cd path/to/filesInstall dev npm modules:
npm install --devgulp buildThis converts all the images and places the other files from the directory public/src to the public/dist folder. Then you can start the browser-sync task to run browser sync with nodemon to auto refresh the browser.
Start Gulp for browser sync:
gulp browser-syncIn the app.js file, you can find the start file of the app. For every route there is a file in the route folder. The files are structured in the way that the path of the file is the path of the URL.
/config //the config of the application
/lib
/hbsHelper.js //the hbs template helpers
/socketConnection.js //connection to the socket
/modules //all the modules from the app
/public
/src
/img //all the images if the application
/js
/css
/routes
/admin //the admin part of the application (for all these routes you need to be logged in)
/api //The API that can be used in the front end
/display //the display route that will be shown on a display
/middleware //the middleware for the routes
/users //to log in and register the users
/sessions //in this folder the sessions files will be saved
/uploads //in this folder the uploaded files will be saved
/views //all the views of the application. It is structured the same as the routes in the routes folder
app.js //the root of the application. This file you need to start.
The app has an API. You can call the API on api/content/:contentId. You'll get all the content from the poster id. The object that you'll get is:
{
"filename": "d9b88e9349d235296e687d0276e74326.jpg",
"name": "CMD golden dot awards flyer ",
"animation": "top-push",
"duration": 10,
"color": "#269A8E",
"dateStart": "06-06-2015",
"dateEnd": "07-12-2016",
"id": 464080
}If the Id is not defined the API will give a error.
{
"error": "Not found"
}In this section I will tell which things I've learned in the schoolsubjects and used in this application.
The client side application part is structured in Modules. Every part of the code is in an IFFE. That is an Immediately-Invoked Function Expression. Only the parts that will be used outside the function will be returned. This is safer than open functions. A hacker can't get access to the other functions in the IFFE. Because the code is modular I can use it in other applications.
With CSS keyframes, you can animate a lot of properties, but most of them are not hardware accelerated. The most used hardware accelerated CSS properties are:
- opacity
- transform: rotate
- transform: scale
- transform: translate
- filter
In my animations in the application, I only used these properties.
I've used a drag gesture to create a better experience with the slideshow editor. This is a self-written gesture.
On the slideshow page, the application gets and sends requests to the server. So the user can edit the order of the posters. The function is located in the public/src/js/app/DPhelper.js file.
On the server the application uses HBS, a server-side variant of Handlebars, to render the pages. Everytime the app needs to render a page the function in the modules/renderTemplate.js file will be called. This function sets all the vars and parse them to HBS.
The application is fully written with flexbox. For other browsers, there is a fallback. You can see the fallback file in public/src/css/layout/fallbackflexbox.css.
The elements in the banner on the home page have a vertical center. Many other elements in the application too. There are also transitions when you hover. The color of the poster preview transitions to dark on a hover. The cursor will hint on elements to show whether you can use them or not. For mobile devices, I've extended the clickable area so it's easier to touch on these elements. The checkboxes, selects and option elements in the app are also customized. On the home page, I've used ::before and ::after elements to show the timeline interface.
When you load the application for the first time, all the CSS will be in the head of the body. (I can use this because the CSS file is only 91Kb) So the first render will be very fast. After this render, the CSS file will load with loadCSS. After the load of this CSS, there will be a cookie set with the value "style=true". If this cookie is in the request of the page it won't give the inline CSS. Now it gives a <link rel="stylesheet" href="/css/style.css">.
The app is using gulp to minify the CSS, JS, and the images. The images on the home page are responsive images. So the browser chooses the right size for the screen.
<picture class="">
<source srcset="/img/home/step1-1500.png" media="(min-width: 1500w)" />
<source srcset="/img/home/step1-1280.png" media="(min-width: 1280w)" />
<source srcset="/img/home/step1-960.png" media="(min-width: 960w)" />
<source srcset="/img/home/step1-960.png" media="(min-width: 640w)" />
<source srcset="/img/home/step1-480.png" media="(min-width: 480w)" />
<img src="/img/home/step1-960.png" alt="">
</picture>All CSS selectors are no more than 3 deep. So the render engine is fast with parsing the CSS. The HTML is semantic and the classes and id's are nicely chosen.
If a browser supports a service Worker it will cache several pages. So the load time of the page will be a lot faster.
The application is a progressive web app. I've created a manifest.json file so the Android phone knows which icons the app should use. Combined with the Service Worker the app could be used offline to view the app.
The google Page speed Insights gives me a 98/100 on mobile and desktop.
In the browser you can see the first paint of the page and other performance tests.
This is tested on a Good 3G (40ms, 1.5mb, 750kb/s)
| function | Time |
|---|---|
| First paint | 195ms |
| Dom load event | 170ms |
| Load event | 1.53s |
All the images have an alt tag, so blind people know what kind of image it is. If the images aren't shown because the user has slow internet the alt tag will show up.
The icons are SVG so if the user has a font blocker or has slow internet the icons will appear. If there is only an icon used for a button there is a title used for the blind people. The app uses inline SVGs with a fallback to a png image.
The whole app can be used by visualy impaired people. The contrasts of the app are big enough to see the difference between the colors. The whole app can be operated with the tab key. So blind people that are advanced users can use the app.
The whole application can be used with voice over. I've tested it with Firefox, Safari and Vivaldi.
The most actions of the application are server side. So a user with low bandwidth can also use the app. The site uses HTTPS so the 'free' hotspots can't insert code to show adds on the site.
The client-side JS is written so that most code can be used by old browsers. I've used document.getElementByID() on places where I was able to use it. So the older browsers also can use the JS enhances.
The application is built on the 3 layers: HTML, CSS & JS. The application is build with HTML5 elements. These elements are backward compatible. Old browsers that don't support these elements will create an unknown element, but the website doesn't break. The website will also work without client-side JS. So the application will work in older browsers or with slow internet.
I haven't used meteor to create a realtime web app, but I've used a socket.io for live reloading the slideshow. If a user adds a new poster or Vimeo to the slideshow the slideshow will reload.
I've used some extra features in my application. Such as MySQL, emailjs, hsb, momentjs and right roles. I didn't follow the 'databases' course, but I wanted to learn MySQL. So I've used MySQL in my application to learn. Now I've learned the most MySQL functions. And I've worked with the raspberry pi. This is a low power mini computer. I've installed the Chromium browser on it and edited the boot files, so it automatically opens the browser on the slideshow page.
The app is tested by some users. After that tests I made some changes on the application.
- redesign flow of adding content to the slideshow. The content is now automatically added to the slideshow. Before this change the admin had to add them manually.
- only one slideshow instead of multiple ones.
- Add a home page with a flow of the application
| Name | Version | Description |
|---|---|---|
| bluebird | 3.4.1 | Full featured Promises/A+ implementation with exceptionally good performance |
| cookie-parser | 1.4.3 | cookie parsing with signatures |
| emailjs | 1.0.5 | send text/HTML emails and attachments (files, streams and strings) from node.js to any smtp server |
| express | 4.13.4 | Fast, unopinionated, minimalist web framework |
| multer | 1.1.0 | Middleware for handling multipart/form-data. |
| express-myconnection | 1.0.4 | Connect/Express middleware that auto provides mysql connections. |
| express-session | 1.10.1 | Simple session middleware for Express |
| gsap | 1.18.5 | Think of GSAP as the Swiss Army Knife of animation...but better. It animates anything JavaScript can touch (CSS properties, canvas library objects, SVG, generic objects, whatever) and it solves countless browser inconsistencies, all with blazing speed (up |
| hbs | 1.18.2 | Express.js template engine plugin for Handlebars |
| MySQL | 2.5.4 | A node.js driver for MySQL. It is written in JavaScript, does not require compiling, and is 100% MIT licensed. |
| body-parser | 1.10.1 | Node.js body parsing middleware |
| moment | 2.9.0 | Parse, validate, manipulate, and display dates |
| session-file-store | 0.0.2 | Session file store is a provision for storing session data in the session file |
| socket.io | 1.4.6 | Node.js realtime framework server |
There are many things to do. Here a feature list with features that could be implemented.
- Better performance on slower devices see #50.
- Ability to delete posters, users, and displays.
- A set up wizard.
- Ability to edit a poster start and end date on the poster detail page.
- Translate the app to dutch.
- Logged-in variant of the home page.
- Ability to change your password.
- Ability to add a profile photo to an account. #33
- Ability to turn off a display (or go on black).
- Ability to upload videos from your mobile phone. (not Vimeo, normal mp4 videos ).
- Optimize uploaded images. So there will be a height resolution, small preview, and a bigger preview.
- Ability to filter the content on the content page, display page, and user page on name or date.
- On old browsers the 'home' button in the menu will sign out the user.
- Make the slideshow editor work on older browsers that don't support draggable.
- Don't show the added posters in the picker on the slideshow edit page.
The Master branch is the branch where the final features are pushed to. The master-v0.5 branch is the old master branch with the old interaction.
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
- Check out the issue tracker to make sure someone hasn't already requested it and/or contributed it.
- Fork the project.
- Start a feature/bugfix branch.
- Commit and push until you are happy with your contribution.
- Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
For CSS I've used cssnext. With this plugin, you can use the CSS syntax that will be supported later by new browsers.
I've used some new JS functions with Babel. This will be converted to code that can be used by older browsers.
I've used Trello for planning the work that I would do each week. I've constantly updated my board so I always knew what to do.
This code is published under Apache License.