Skip to content

Latest commit

 

History

History
 
 

readme_template

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 

README.md

Readme Introduction

This is a guide for how to set up your README.md file for your IronHack Application. The file should have following fields:

  1. Name of your Application

  2. Keywords You should include at least 3 keywords for your project to identify the features of your project, such as: freshness, price, transportation convenience

  3. Description of the datasets and function design

  • [name] [link] [data type] [data columns used] [data amount] Please provide a name+link+basicInfo to each dataset you have used.
  • [Y/N] Do you use the primary dataset ”online climate data” from data.gov?
  • [Y/N] [List] Are all these datasets from data.gov or data.indy.gov? If not, where are they coming from (links)?
  1. Brief Description
  • Use a paragraph to introduce your project.

Fill in the structued description:

  • Map View:

    1. [Y/N] Basic Map with specific location (your map is located in a meaningful place, city of west lafayette for example)
    2. [Y/N] Markers for location of markets
    3. [Y/N] Labels for markets' names
    4. [Y/N] InfoWindow to show detail information of a market
    5. [Y/N] [describe] Any other cover on the map (for example, cloud cover to show the weather effect)

  • Data Visualization:

    1. [Y/N] [describe] Use Graph? What is the type? (bar chart, pie chart, radar chart ...)
    2. [Y/N] [List] Any interaction available on the graph? List them (enable click on numbers, drag on lines, change time/variables ...)

  • Interaction Form:

    1. [Y/N] [List] Any information output? list them. (text field, text area, label, plain HTML ...)
    2. [Y/N] [List] Any operation option (filters)? List them. (search markets, search vegetables, filter based on price, sort based on convenience ...)
    3. [Y/N] [List] Any information input? List them. (comments, markers, user preference ...)
    4. [Y/N] [List] Interaction with Map? List them. (filter on price will affect map markers, sort on price will affect map markers, ...)
    5. [Y/N] [List] Interaction with data visualization? List them. (filter, sort, set variables ...)

  1. Build Case How can we build and access your project on a Linux/Unix machine if you use external dependencies besides HTML/CSS/Javascript? List the dependencies you used, such as python, node.js, etc. List the steps we should follow to build the project.

  2. Test Case Which browsers did you test your project on? Chrome, IE, Edge, Safari, or Firefox?

  3. Additional information You Want to Share with Us E.g. any problems you faced/fixed, where you reached out to for help, etc.