hwhang0917 / photorganizer

Project for Spring 2020 Course of Software Engineering

Photorganizer

• Quick Note
  • Use the following command to clone git repository to your local computer

  git clone https://github.com/hwhang0917/photorganizer.git

  • Install Yarn

Project Members

• Heesang Mark Whang
• Subin Kim
• Akhigbe Unuigbe

Project Description

This is an image organizing web based application. This is a group project for the course Software Engineering (CSCI450) instructed by professor Grace Lew.

• General Guide

  We will use Yarn Package Manager for all dependency management.

  • Discord Server

• Backend Side Guide

  Our project uses is written with JavaScript. Thus the project uses Node.JS, which is a tool helps run JavaScript outside of the browser and run within the system. Node JS has a server framework called ExpressJS that can be used to build quick servers.

• Frontend Side Guide

  Our project renders HTTP requests and show user interface through PugJS and SCSS / SASS as view engine.

• Dev Ops Guide

  Our project uses GulpJS to control build flow and pipeline to integrate Babel / Scss / Pug into browser compatible JavaScript, CSS , and HTML.

Dev Command Guide

This process will start a development server in localhost

1. Install Dependencies

   yarn install

2. Run Develop Assets

   This process will watch client side assets (JS, SCSS, PUG, etc)

   yarn run dev:assets

3. Run Develop Server

   This process will watch server side code (express server, etc)

   yarn run dev:server

Dependencies Reference and Guides

The following are useful links and dependency documentations.

Used Tool Links

• Node JS
• Yarn
• Figma Wireframing Tool

Dependency Suggestion

• Electron JS

Express Server Middleware

The backend Express server utilizes some middleware. These are the imported middleware for convenience.

• Morgan
  • HTTP Logger
• Helmet
  • HTTP header security

Guide Links

Most of the NPM/YARN packages have their own documentations. You can view their documentations for more information. The following are extra resources that can be guide for this project.

• Git Cheatsheet

Tasks Checklist

• SPMP
• SRS
• SDD
• Scrum Back Log
• Wireframe
• Scrum Product Backlog
• Sprint #1 / Backlog Burndown #1
• Sprint #2 / Backlog Burndown #2
• Sprint #3 / Backlog Burndown #3
• Sprint #4 / Backlog Burndown #4
• Testing
• Deployment
• Final Presentation Prepare

Tasks

• Project Setting (Dev Ops)
  • SCSS / Babel Build flow
• Routing
• Server
• Page Rendering using Pug and SCSS
  • Pug
  • SCSS
• Pages
  • Landing Page (Home)
  • Login
  • Reset Password
  • Join
  • Dashboard
  • Image Detail
  • Settings