Cloudenvy7 / 05-form-building

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CF Lab 05: Form Building Workshop

Lab 05 Submission Instructions

Follow the submission instructions from Lab 01.

Resources

HighlightJS Docs

MarkedJS Docs

Configuration

Your repository must include:

05-form-building
└── starter-code
└── driver-navigator
  ├── .eslintrc.json
  ├── .gitignore
  ├── LICENSE
  ├── index.html
  ├── new.html
  ├── scripts
  │   ├── article.js
  │   ├── articleView.js
  │   └── blogArticles.js
  ├── styles
  │   ├── base.css
  │   ├── layout.css
  │   └── modules.css
  └── vendor
      └── styles
          ├── fonts
          │   ├── icomoon.eot
          │   ├── icomoon.svg
          │   ├── icomoon.ttf
          │   └── icomoon.woff
          ├── default.css
          ├── icons.css
          ├── normalize.css
          └── railscasts.css
  └── PULL_REQUEST_TEMPLATE.md
  └── README.md

User Stories and Feature Tasks

As a user, I want to be able to add new articles to my blog app so that it can stay current over time.

  • Review the image preview.png in the lab directory to get an idea of what we will be building.
  • Focus on the functionality of adding a new article through a form submission by completing the TODOs in articleView.js.
  • The new page with the form should provide a JSON string which can be copy/pasted into the data file to add articles to the blog.

As a developer, I want to make the user experience easy to understand so that the user will want to return to the blog.

  • We now have two pages in our blog app, each of which need different initialization. There is a skeleton of a method in articleView.js to get this started for the new page; be sure to examine how this is now being done for the index page.
  • The new page with the form will need event handling and a template. Where should these pieces go in the code?
  • The new page should not display any other articles; how to manage this?

Stretch Goal

As a user, I want to add highlighting and Markdown formatting so that it is attractive to guests visiting my app.

  • We have two new libraries that we can add: HighlightJS (provides syntax highlighting of code blocks) and MarkedJS (allows use of Markdown format text). Link to (or include) these two libraries and implement them.

Documentation

Your README.md must include:

# Project Name

**Author**: Your Name Goes Here
**Version**: 1.0.0 (increment the patch/fix version number up if you make more commits past your first submission)

## Overview
<!-- Provide a high level overview of what this application is and why you are building it, beyond the fact that it's an assignment for a Code Fellows 301 class. (i.e. What's your problem domain?) -->

## Getting Started
<!-- What are the steps that a user must take in order to build this app on their own machine and get it running? -->

## Architecture
<!-- Provide a detailed description of the application design. What technologies (languages, libraries, etc) you're using, and any other relevant design information. -->

## Change Log
<!-- Use this are to document the iterative changes made to your application as each feature is successfully implemented. Use time stamps. Here's an examples:

01-01-2001 4:59pm - Application now has a fully-functional express server, with GET and POST routes for the book resource.
-->

## Credits and Collaborations
<!-- Give credit (and a link) to other people or resources that helped you build this application. -->

About


Languages

Language:HTML 49.7%Language:JavaScript 33.6%Language:CSS 16.6%