Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 12 additions & 89 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,16 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===

Due: September 16th, by 11:59 PM.

This assignment aims to introduce you to the concepts and practice involved in creating a prototype (i.e. not deployment ready) two-tiered web application. The baseline aims of this assignment involve creating an application that demonstrates the use of several specific pieces of HTML, CSS, JavaScript, and Node.js functionality.

Baseline Requirements
---

Note that there is a very large range of application areas and possibilities that meet these baseline requirements. Make your application do something useful! A todo list, storing / retrieving high scores for a very simple game, have a little fun with it.

Your application is required to implement the following functionalities:

- a `Server` which not only serves files, but also maintains a tabular dataset with 3 or more fields related to your application
- a `Results` functionality which shows the entire dataset residing in the server's memory
- a `Form/Entry` functionality which allows a user to add, modify, or delete data items residing in the server's memory
- a `Server Logic` which, upon receiving new or modified "incoming" data, includes and uses a function that adds at least one additional derived field to this incoming data before integrating it with the existing dataset
- the `Derived field` for a new row of data must be computed based on fields already existing in the row. For example, a `todo` dataset with `task`, `priority`, and `creation_date` may generate a new field `deadline` by looking at `creation_date` and `priority`

Your application is required to demonstrate the use of the following concepts:

HTML:
- One or more [HTML Forms](https://developer.mozilla.org/en-US/docs/Learn/HTML/Forms), with any combination of form tags appropriate for the user input portion of the application
- A results page displaying all data currently available on the server. You will most likely use a `<table>` tag for this, but `<ul>` could also work and might be simpler to work with.
- All pages should [validate](https://validator.w3.org)

CSS:
- CSS styling of the primary visual elements in the application
- Various CSS Selector functionality must be demonstrated:
- Element selectors
- ID selectors
- Class selectors
- CSS positioning and styling of the primary visual elements in the application:
- Use of either a CSS grid or flexbox for layout
- Rules defining fonts for all text used; no default fonts! Be sure to use a web safe font or a font from a web service like [Google Fonts](http://fonts.google.com/)

- CSS defined in a maintainable, readable form, in external stylesheets

JavaScript:
- At minimum, a small amount of front-end JavaScript to get / fetch data from the server; a sample is provided in this repository.

Node.js:
- An HTTP Server that delivers all necessary files and data for the application. A starting point is provided in this repository.

Deliverables
---

Do the following to complete this assignment and acheive a base grade of 85%:

1. Fork the starting project code (make sure to fork the 2020 repo!). This repo contains some starter code that may be used or discarded as needed.
2. Implement your project with the above requirements.
3. Test your project to make sure that when someone goes to your main page, it displays correctly.
4. Deploy your project to Glitch, and fill in the appropriate fields in your package.json file.
5. Ensure that your project has the proper naming scheme `a2-yourname` so we can find it.
6. Modify the README to the specifications below.
7. Create and submit a Pull Request to the original repo. Label the pull request as follows: a2-gitusername-firstname-lastname

Acheivements
---

Below are suggested technical and design achievements. You can use these to help boost your grade up to an A and customize the assignment to your personal interests. These are recommended acheivements, but feel free to create/implement your own... just make sure you thoroughly describe what you did in your README and why it was challenging. ALL ACHIEVEMENTS MUST BE DESCRIBED IN YOUR README IN ORDER TO GET CREDIT FOR THEM.

*Technical*
- (10 points) Create a single-page app that both provides a form for users to submit data and always shows the current state of the server-side data. To put it another way, when the user submits data, the server should respond sending back the updated data (including the derived field calculated on the server) and the client should then update its data display.

*Design/UX*
- (5 points per person, with a max of 10 points) Test your user interface with other students in the class. Define a specific task for them to complete (ideally something short that takes <10 minutes), and then use the [think-aloud protocol](https://en.wikipedia.org/wiki/Think_aloud_protocol) to obtain feedback on your design (talk-aloud is also find). Important considerations when designing your study:

1. Make sure you start the study by clearly stating the task that you expect your user to accomplish.
2. You shouldn't provide any verbal instructions on how to use your interface / accomplish the task you give them. Make sure that your interface is clear enough that users can figure it out without any instruction, or provide text instructions from within the interface itself.
3. If users get stuck to the point where they give up, you can then provde instruction so that the study can continue, but make sure to discuss this in your README. You won't lose any points for this... all feedback is good feedback!

You'll need to use sometype of collaborative software that will enable you both to see the test subject's screen and listen to their voice as they describe their thoughts. After completing each study, briefly (one to two sentences for each question) address the following in your README:

1. Provide the last name of each student you conduct the evaluation with.
2. What problems did the user have with your design?
3. What comments did they make that surprised you?
4. What would you change about the interface based on their feedback?

*You do not need to actually make changes based on their feedback*. This acheivement is designed to help gain experience testing user interfaces. If you run two user studies, you should answer two sets of questions.

Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
---

## Your Web Application Title
Include a very brief summary of your project here. Be sure to include the CSS positioning technique you used, and any required instructions to use your application.
## Order Placing and Fulfilling Platform
https://a2-ikyriazis.glitch.me/
This website allows users to place orders. Only one type of product is available but comes in different colors and sizes. The user also enters the quantity of the product
they desire. The administrator can then remove orders from the database once they fulfill the orders. I used a flexbox to align the elements of the webpage.

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
- **Tech Achievement 1**: I use a table to display all the data stored in the server. It is updated every time an order is placed or fulfilled. The derived field is the order number.
This field is derived from the previous order number.

### Design/Evaluation Achievements
- **Design Achievement 1**:
- **Design Achievement 1**: I use the Kumbh Sans font from Google Fonts.
- **Design Achievement 2**: I use two colors I've obtained from the Adobe color wheel.
- **Evaluation Achievement 1**: I ran a user study on my girlfriend. I told her to fulfill order number 13 when there were 15 orders in the database. She had no trouble with it.
- **Evaluation Achievement 2**: I ran a user study on my 9-year-old brother. I told him to place an order for "5 green mediums". At first he thought he could edit the table directly.
When that didn't work he looked at the form and saw that he could select colors and sizes. He then was about to place an order without a quantity but I reminded him that he
needs 5 of them. He then put the correct quantity and submitted the order. From this I learned that my application isn't the most intuitive to a 9-year-old.
39 changes: 38 additions & 1 deletion public/css/style.css
Original file line number Diff line number Diff line change
@@ -1 +1,38 @@
/*Style your own assignment! This is fun! */
/*Style your own assignment! This is fun! */
/*
Various CSS Selector functionality must be demonstrated:

Element selectors
ID selectors
Class selectors
*/
table{
display: flex;
justify-content: center;
align-content: space-evenly;
border-collapse: collapse;
}
td, th {
background-color: white;
border: solid #1A6166 3px;
padding: 5px;
}

.admin {
display: flex;
justify-content: center;
align-content: space-evenly;
align-items: stretch;
}
#client {
display: flex;
justify-content: center;
align-content: space-evenly;
align-items: stretch;
}

body {
font-family: 'Kumbh Sans', sans-serif;
background-color: #3EACB3;
}

111 changes: 98 additions & 13 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,123 @@
<head>
<title>CS4241 Assignment 2</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css">
<link href="https://fonts.googleapis.com/css2?family=Kumbh+Sans&display=swap" rel="stylesheet">
</head>
<body>
<form action="">
<input type='text' id='yourname' value="your name here">
<button>submit</button>
</form>
<table id="orders">
</table>
<br>
<div class = "admin">
<form action="">
<!-- Fulfill order menu -->
<input type="number" id="orderNum" placeholder="Order number">
<button id="fulfill">Fulfill</button>
</form>
</div>
<br>
<div id="client">
<form action="">
<!-- Order Form -->
<select id="color">
<option value="blue">Blue</option>
<option value = "red">Red</option>
<option value = "green">Green</option>
<option value = "purple">Purple</option>
<option value = "orange">Orange</option>
<option value = "yellow">Yellow</option>
<option value = "white">White</option>
<option value = "black">Black</option>
</select>
<select id="size">
<option value="small">Small</option>
<option value="medium">Medium</option>
<option value="large">Large</option>
</select>
<input type="number" id="quantity" placeholder="Quantity">
<button id="order">Buy now</button>
</form>
</div>
</body>
<script>

const submit = function( e ) {
const submitOrder = function( e ) {
// prevent default form action from being carried out
e.preventDefault()
e.preventDefault();

const input = document.querySelector( '#yourname' ),
json = { yourname: input.value },
body = JSON.stringify( json )
const color = document.getElementById( 'color' ),
quantity = document.getElementById('quantity'),
size = document.getElementById('size'),
json = {type: "order", color: color.value, size: size.value, quantity: quantity.value},
body = JSON.stringify( json );
console.log("Submitting order");

fetch( '/submit', {
method:'POST',
body
})
.then( function( response ) {
// do something with the reponse
console.log( response )
// do something with the response
return response.text();
}).then( function(txt) {
let appdata = JSON.parse(txt);
generateTable(appdata);
return false;
})

return false
};

const fulfillOrder = function(e) {
// prevent default form action from being carried out
e.preventDefault();

const orderNum = document.getElementById( 'orderNum' ),
json = {type: "fulfill", orderNum: orderNum.value},
body = JSON.stringify( json );

fetch( '/submit', {
method:'POST',
body
})
.then( function( response ) {
// do something with the response
return response.text();
}).then( function(txt) {
let appdata = JSON.parse(txt);
generateTable(appdata);
return false;
})

return false
};

function generateTable(appdata) {
let table = document.getElementById('orders');
table.innerHTML = "";
let thead = table.createTHead();
let row = thead.insertRow();
for (let key of Object.keys(appdata[0])) {
let th = document.createElement("th");
let text = document.createTextNode(key);
th.appendChild(text);
row.appendChild(th);
}
for (let element of appdata) {
let row = table.insertRow();
for (let key in element) {
let cell = row.insertCell();
let text = document.createTextNode(element[key]);
cell.appendChild(text);
}
}
}

window.onload = function() {
const button = document.querySelector( 'button' )
button.onclick = submit
const orderButton = document.getElementById( 'order' );
const fulfillButton = document.getElementById('fulfill');
fulfillButton.onclick = fulfillOrder;
orderButton.onclick = submitOrder;
}

</script>
Expand Down
69 changes: 45 additions & 24 deletions server.improved.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,67 +6,88 @@ const http = require( 'http' ),
dir = 'public/',
port = 3000

const appdata = [
{ 'model': 'toyota', 'year': 1999, 'mpg': 23 },
{ 'model': 'honda', 'year': 2004, 'mpg': 30 },
{ 'model': 'ford', 'year': 1987, 'mpg': 14}
]
// const appdata = [
// { 'model': 'toyota', 'year': 1999, 'mpg': 23 },
// { 'model': 'honda', 'year': 2004, 'mpg': 30 },
// { 'model': 'ford', 'year': 1987, 'mpg': 14}
// ]

let appdata = [
{orderNum: 1, color: "blue", size: "small", quantity: 2}
];

const server = http.createServer( function( request,response ) {
if( request.method === 'GET' ) {
handleGet( request, response )
}else if( request.method === 'POST' ){
handlePost( request, response )
}
})
});

const handleGet = function( request, response ) {
const filename = dir + request.url.slice( 1 )
const filename = dir + request.url.slice( 1 ) ;

if( request.url === '/' ) {
sendFile( response, 'public/index.html' )
}else{
sendFile( response, filename )
}
}
};

const handlePost = function( request, response ) {
let dataString = ''
let dataString = '';

request.on( 'data', function( data ) {
dataString += data
})
dataString += data;
});

request.on( 'end', function() {
console.log( JSON.parse( dataString ) )

const json = JSON.parse(dataString);
// this request is an order
if (json.type === "order") {
const orderNum = appdata.length === 0? 1 : appdata[appdata.length - 1].orderNum + 1;
appdata.push({orderNum: orderNum, color: json.color, size: json.size, quantity: json.quantity})
}
// this request is a fulfillment
else if (json.type === "fulfill") {
let orderNum = json.orderNum;
let i;
for (i = 0; i < appdata.length; i++) {
if (appdata[i].orderNum.toString() === orderNum) {
appdata.splice(i, 1);
}
}
}
else {
// this is an invalid request
console.log("invalid json");
}
// ... do something with the data here!!!

response.writeHead( 200, "OK", {'Content-Type': 'text/plain' })
response.end()
response.writeHead( 200, "OK", {'Content-Type': 'text/plain' });
response.end(JSON.stringify(appdata));
})
}
};

const sendFile = function( response, filename ) {
const type = mime.getType( filename )
const type = mime.getType( filename );

fs.readFile( filename, function( err, content ) {

// if the error = null, then we've loaded the file successfully
if( err === null ) {

// status code: https://httpstatuses.com
response.writeHeader( 200, { 'Content-Type': type })
response.end( content )
response.writeHeader( 200, { 'Content-Type': type });
response.end( content );

}else{

// file not found, error code 404
response.writeHeader( 404 )
response.end( '404 Error: File Not Found' )
response.writeHeader( 404 );
response.end( '404 Error: File Not Found' );

}
})
}
};

server.listen( process.env.PORT || port )
server.listen( process.env.PORT || port );