/email-module-manager

stensul's email module manager

Primary LanguageJavaScript

Stensul Email Modules

This app provides a real-time synchronized manager of stensul's email modules

Live Demo: stensul email module manager

Development steps

  1. Parse statement
  • Result:

    • Models:

       Item {
 	picture     [size=(320,  320), type=(gif | jpeg | png)],
 	description [max_length=300]
 }

    • Available actions (all without refreshing the page):

      • Drag and drop sort
      • Item counter (auto updated)
      • Item edition
        • Picture upload
        • Description edit
      • Item deletion
      • Item insertion

    • Requirements:

      • Item persistent storage
  1. Make architectural decisions:
  • Use Firebase as backend for simplicity, ease of use, storage availability and deeper learning and practise interest.
  • Use npm to run tasks and install 3rd party libraries and tools.
  • Use Webpack to bundle all js, minify, version assets, build index.html and load libraries.
  • Link this demo project with stensul business to work on more real context using email modules as items.
  1. Make design decisions:
  • Create Item and ItemCollection model to ease development and avoid errors
  • Create logic and display layers, all item updates are made in logic layer
  1. Select tools:
  • Webstorm IDE
  • Git and GitHub
  • Firebase (BaaS)
  • Webpack (module bundler)
  • Chrome Inspector
  • JS, HTML, CSS, SASS (BEM)
  • Libraries:
    • Firebase for JS
    • Materialize CSS
  1. Initialize project:
  • Create GitHub repo
  • Setup Git
  • Setup npm
  • Setup Webpack
  • Setup Firebase hosting and deploy

Note: No 3rd party boilerplate or template was used for this project.

  1. Start development

  2. Review code and add documentation

  3. Push changes

Note: None of git best practices (branching model, atomic commits, etc) will be applied, source will be pushed in bulk because of project size, team size and time restrictions

Installation instructions

Run:

# npm install -g firebase-tools
# npm install -g webpack webpack-dev-server
$ npm install
$ npm start

Known issues

  • Ugly alerts are used for validation errors
  • Images are not removed from server when item is removed
  • SPA is not mobile responsive
  • MaterializeCSS SASS distribution could have been used to avoid presentational classes in HTML elements