Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

a2-justgaret23-Garrett-Sheehan #77

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
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
106 changes: 15 additions & 91 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,21 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===

Due: September 9th, by 11:59 AM.

This assignment aims to introduce you to creating a prototype two-tiered web application.
Your application will include the use of HTML, CSS, JavaScript, and Node.js functionality, with active communication between the client and the server over the life of a user session.

Baseline Requirements
---

There is a large range of application areas and possibilities that meet these baseline requirements.
Try to 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>` or `<ol>` 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, and also creates the required `Derived Fields` in your data.
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 2021 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-yourGithubUsername` so we can find it.
6. Modify the README to the specifications below, and delete all of the instructions originally found in this README.
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.
## Press the key before the time runs out!
https://a2-justgaret23.glitch.me/
This application is a "simon says" game where the user has to press random keys in time with a ever-decreasing interval. The player can input
their score into the game leaderboard upon a game over. By entering the admin password, the user can also delete any scores they please.

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
- **Tech Achievement 1**: Made the leaderboard update in real time whenever somebody adds or deletes a score from it.
- **Tech Achievement 2**: Using the admin password "Enter the Konami Code", anyone can delete a score from the leaderboard.

### Design/Evaluation Achievements
- **Design Achievement 1**:
- **Ayvazian**:
- The design was too scrunched to the left, with the game taking up a small amount of screen space.
- I did not expect him to suggest putting the admin password on the right side of the screen.
- I would make the application prettier, with everything more towards

- **Grubb (Physics MASH tutor, kinda got crunched for time)**:
- Entering the name after playing the game was a bit unintuitive
- I didn't expect him to press to suggest entering the name before starting, I modeled this strictlyafter arcade games so it was an interesting perspective
- I would make the application prettier and also input an option that allows you to put in your name before
11 changes: 11 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

60 changes: 59 additions & 1 deletion public/css/style.css
Original file line number Diff line number Diff line change
@@ -1 +1,59 @@
/*Style your own assignment! This is fun! */
:root {
--dark-blue: #91bdd3;
--light-blue: #57C7FF;
--blue: #3BB7F5;
--dark-brown: #A86007;
--light-brown: #b48142;
}

body {
-webkit-transition:background-color 1s ease;
-moz-transition:background-color 1s ease;
-o-transition:background-color 1s ease;
transition:background-color .1s ease;
background-color: var(--dark-blue);
}

section {
display: flex;
flex-direction: row;;
}

main {

}

.gameForm{
padding-right: 20px;
}

.gameLabel{
font-family: 'Source Code Pro', serif;
color: var(--dark-brown);
}

#game-leaderboard{
border-collapse: separate;
border-radius: 13px;
margin: 25px 0;
font-size: 0.9em;
font-family: 'Source Code Pro', serif;
text-align: center;
min-width: 400px;
box-shadow: 0 0 20px rgba(0,0,0, 0.15);
}

#game-leaderboard thead tr{
background-color: var(--dark-blue);
color: var(--light-brown);
}

#game-leaderboard th,
#game-leaderboard td{
padding: 12px 15px;
}

#game-leaderboard tbody tr{
border-bottom: 1px solid #dddddd;
color: var(--dark-brown);
}
190 changes: 160 additions & 30 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,169 @@
<head>
<title>CS4241 Assignment 2</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">

<link rel="stylesheet"
href="https://fonts.googleapis.com/css?family=Source+Code+Pro">
<link rel="stylesheet" type="text/css" href="../css/style.css">

</head>
<body>
<form action="">
<input type='text' id='yourname' value="your name here">
<button>submit</button>
</form>
</body>
<script>

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

const input = document.querySelector( '#yourname' ),
json = { yourname: input.value },
body = JSON.stringify( json )
<main>
<div id="directions" class="gameLabel"><h3>Press the key before time runs out!</h3></div>
<div id="message" class="gameLabel">Start the game to get prompts!</div>
<div id="score" class="gameLabel">Score: 0</div>
<button id="start-button" type="button" onclick="gameLoopSetup()">Start Game</button>
</main>

fetch( '/submit', {
method:'POST',
body
})
.then( function( response ) {
// do something with the reponse
console.log( response )
})
<section>
<form action="/submit-player-score" class="gameForm" method="post">
<h3 class="gameLabel">Input Player Score</h3>
<ul>
<li>
<label for="playername" class="gameLabel">Name:</label>
<input type='text' id='playername' name="your name here">
</li>
<li>
<label id="playerscore" class="gameLabel">Score:</label>
<label id="savedScore" class="gameLabel">0</label>
</li>
</ul>

<button id = "submit">Enter Score</button>
</form>

<form action="/access-player-delete" class="gameForm" method="post">
<h3 class="gameLabel">Admin Password</h3>
<ul>
<li>
<input type='password' id='adminpassword'>
</li>
</ul>

<button id = "adminAccessButton" class="gameLabel">Enter Admin Password</button>
</form>

<form action="/delete-player-score" id ="deleteScoreForm" class="gameForm" method="post">
<h3 class="gameLabel">Delete Player Score</h3>
<ul>
<li>
<label for="deletename" class="gameLabel">Name:</label>
<input type='text' id='deletename' name="your name here">
</li>
</ul>

<button id = "deleteButton">Delete</button>
</form>
</section>
<table id="game-leaderboard">

return false
}
</table>
<script src='../js/scripts.js'></script>
<script>

window.onload = function() {
const button = document.querySelector( 'button' )
button.onclick = submit
}

</script>
const submit = function( e ) {
// prevent default form action from being carried out
e.preventDefault()

const input = document.querySelector( '#playername' ),
scoreinput = document.querySelector('#playerscore'),
json = { playername: input.value, playerscore: playerScore },
body = JSON.stringify( json )

fetch( '/submit', {
method:'POST',
body //shortened version of "body": body
//If there is only one word, it is taken in as the key and value
})
.then( function( response ) {

//do something with the reponse
response.text().then(function(textdata) {
console.log(JSON.parse(textdata));
let newAppdata = JSON.parse(textdata);

makeTableFromData(newAppdata);
})
//let newResponse = JSON.parse(response)
//console.log(newResponse[0].name);
})

return false
}


const deleteScore = function(e){
e.preventDefault();

const input = document.querySelector( '#deletename' ),
json = { playername: input.value},
body = JSON.stringify( json )

fetch('/deleteScore', {
method: 'POST',
body
})
.then(function( response) {
//do something with the reponse
response.text().then(function(textdata) {
console.log(JSON.parse(textdata));
let newAppdata = JSON.parse(textdata);

makeTableFromData(newAppdata);
})
//let newResponse = JSON.parse(response)
//console.log(newResponse[0].name);

})
}

const getLeaderboard = function(e){
e.preventDefault();

fetch('/getLeaderboard', {
method: 'GET',
body
})
.then(function( response) {
//do something with the reponse
response.text().then(function(textdata) {
console.log(JSON.parse(textdata));
let newAppdata = JSON.parse(textdata);

makeTableFromData(newAppdata);
})
//let newResponse = JSON.parse(response)
//console.log(newResponse[0].name);

})
}

const adminAccess = function(e){
e.preventDefault();
const secretDoc = document.getElementById("deleteScoreForm");
const input = document.querySelector( '#adminpassword')

if(input.value === "Enter the Konami Code"){
secretDoc.style.display = "block";
}

}


window.onload = function() {
const button = document.getElementById( 'submit' )
button.onclick = submit

const deleteButton = document.getElementById('deleteButton');
deleteButton.onclick = deleteScore;

const adminButton = document.getElementById("adminAccessButton");
adminButton.onclick = adminAccess;
}

</script>
</body>
</html>

Loading