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-echo532-Nicholas-Heineman #64

Open
wants to merge 12 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
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

node_modules/.bin/mime
node_modules/.bin/mime.cmd
node_modules/.bin/mime.ps1
node_modules/.package-lock.json
node_modules/mime/CHANGELOG.md
node_modules/mime/cli.js
node_modules/mime/index.js
node_modules/mime/LICENSE
node_modules/mime/lite.js
node_modules/mime/Mime.js
node_modules/mime/package.json
node_modules/mime/README.md
node_modules/mime/types/other.js
node_modules/mime/types/standard.js
package-lock.json
116 changes: 35 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,54 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===

Due: September 11th, by 11:59 AM.
Nicholas Heineman
https://webware-character-creator.glitch.me/

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 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:
## Character Manager

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. Alternatively, you can create a single-page app (see Technical Acheivements) but this is not a requirement.
- All pages should [validate](https://validator.w3.org)
- If your app contains multple pages, they should all be accessible from the homepage (index.html)
This project is a mockup/beginnings of a website that could be used to manage characters for someone creating a book or a game with history they want to keep track of. It is specifically focused around keeping track of time, and one can create, delete and modify eras on the timeline that appears to the right. Then, any characters they create will be sorted into the eras on the timeline with real time updating.

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/)
## Project Structure:
one HTML file, index.html, used to structure both the two tabs and the timeline.

- CSS defined in a maintainable, readable form, in external stylesheets
one js file to manage the server, server.improved.js

JavaScript:
- At minimum, a small amount of front-end JavaScript to get / fetch data from the server; a sample is provided in this repository.
3 js/css file pairs:
-main.css/main.js, used to handle styling and code for the main page
-timeline.css/timeline.js, handling styling and code for the timeline
-characterSheet.css/characterSheet.js, handling stylnig and code for the character sheet.

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.
## Functionalities Implemented:
-Server, contained in server.improved.js.
-Results: this is presented in multiple screens, but the two datasets are visible from the characters tab, and the timeline is always visible.
-Form/Entry: both sets of data have from/entry capability, which is done by filling in the form boxes and clicking submit.
-server logic: When a character is submitted, the server looks at the birth/death and calculates which eraI(s) that character belongs to. This updates in real time.
-derived field: See above. I'm aware the data is not from the new sent data, but it refers to other submissions and I believe this fullfills the spirit of this task.

Deliverables
---

Do the following to complete this assignment and acheive a base grade of 85%:
## Concepts Implemented:
-HTML: all content contained in index.html, data is presented
-CSS:
-Used all of the CSS selector types, including connecting to classes, and elements
-styled and positioned all of the elements, used non-default font
-all CSS content in seperate stylesheets organized in a way I thought made sense
-Javascript
-code that fullfills the requirement of sending/receiving data
-Node.js
-fullfills the requirements of creating the derived fields

1. Fork the starting project code (make sure to fork the 2023 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
---
## Achievements:
-5 Points: create app that allows submission of data and updates current server-side data. It is possible to see the changes in clientside when something is added, and more importantly, the derived fields will update with the new information that is changed in the timeline. I don't know about "one-page app" but all of this is part of one HTML file, and it is possible to see this all one one page

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. Remember, the highest grade you can get on any individual assignment is a 100%.
-5 Points: Add ability to modify data. Both the character and timeline items can be modified. To do this, enter in values in the submissions tab, and click the relevant 'modify' button on each item, what is in the submission boxes will go into

*Technical*
- (5 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.
-5 Points, UI study:
Student: Will Ryan
Problems with design: Timeline box spacing and organization could be improved, standardization of button sizes/colors (specifically, get submit button on same line as other boxes in the timeline)
Comments they made that surprised you: "All in all it's not bad tho"
What you would change: I would spend time sizing the timeline specifically, ensure text fits properly in the boxes, improve organization of them

- (5 points) In addition to a form enabling adding and deleting data on the server, also add the ability to modify existing data.

*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 fine). 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, or conduct the studies in person. 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.

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...

### Design/Evaluation Achievements
- **Design Achievement 1**:
17 changes: 17 additions & 0 deletions public/css/characterSheet.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#characterErrorMessage {
color: red;
display: none;

}

table {
border: 1px solid;

}

th,
td {
border: 1px solid black;
width: 150px;
overflow: clip;
}
62 changes: 60 additions & 2 deletions public/css/main.css
Original file line number Diff line number Diff line change
@@ -1,4 +1,62 @@

@import url('https://fonts.googleapis.com/css?family=Trirong');
body {
background:black;
color:white;
background:gray;
color:black;
font-family: "Trirong", sans-serif;
}

p{
max-width: 800px;
}

#lotr_map {
background-color: transparent;
}

table {
border: 1px solid black;
table-layout: fixed;
width: 200px;
}

.timelineContainer{
background: black;
position: absolute;
top: 70px;
right:100px;
max-width: 550px;
margin: 0 right;
}

.tab{
overflow:hidden;
border: 1px solid #ccc;
background-color: #f1f1f1
}

.tab button {
background-color: inherit;
float: left;
border: none;
outline: none;
cursor: pointer;
padding: 14px 16px;
transition: 0.3s;
}

.tab button:hover {
background-color: #ddd;
}

.tab button.active {
background-color: #ccc;
}

.tabContent {
display: none;
padding: 6px 12px;
border: 1px solid #ccc;
min-height: 700px;
border-top: none;
}
77 changes: 77 additions & 0 deletions public/css/timeline.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
* {
box-sizing: border-box;
}

#timelineSubmission {
width: 100%;
text-align: left;
color:white
}

#timelineErrorMessage {
color: red;
display: none;

}

#timelineDeleteButton{
color:red
}

/* The actual timeline */
.timeline {
position: relative;
max-width: 500px;
margin: 0 auto;
min-height: 500px;
max-height: 500px;
overflow-y: auto;
}


/* Container around content */
.container {
padding: 10px 40px;
position: relative;
background-color: inherit;
width: 50%;
}


/* The circles on the timeline */
.container::after {
content: '';
position: absolute;
width: 25px;
height: 25px;
right: -17px;
background-color: white;
border: 4px solid #FF9F55;
top: 15px;
border-radius: 50%;
z-index: 1;
}



/* The actual content */
.content {
padding: 20px 30px;
background-color: white;
position: relative;
border-radius: 6px;
}

/* the vertical ruler */
.content::after {
content: '';
position: absolute;
width: 6px;
background-color: white;
top: 0;
bottom: 0;
left: 210px;
margin-top: 10px;
margin-bottom: -30px;
margin-left: -3px;
}
Binary file added public/images/lotr_map.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading