Skip to content

a3-frank-mcshan #100

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

Open
wants to merge 11 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
USER_NAME=frank
PASSWORD=frank
HOST="cs4241-assignment-3.uvkfsld.mongodb.net/?retryWrites=true&w=majority"
141 changes: 32 additions & 109 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,116 +1,39 @@
Assignment 3 - Persistence: Two-tier Web Application with Database, Express server, and CSS template
===

Due: September 22nd, by 11:59 AM.

This assignnment continues where we left off, extending it to use the most popular Node.js server framework (express),
a database (mongodb), and a CSS application framework / template of your choice (Boostrap, Material Design, Semantic UI, Pure etc.)

Baseline Requirements
---

Your application is required to implement the following functionalities:

- a `Server`, created using Express (no alternatives will be accepted for this assignment)
- a `Results` functionality which shows all data associated with a logged in user (except passwords)
- a `Form/Entry` functionality which allows users to add, modify, and delete data items (must be all three!) associated with their user name / account.
- Use of at least five [Express middleware packages](https://expressjs.com/en/resources/middleware.html). Explore! One of these five middleware
can be a custom function that you write yourself; if you choose to do this, make sure to describe what this function is in your README.
- Persistent data storage in between server sessions using [mongodb](https://www.mongodb.com/cloud/atlas)
- Use of a [CSS framework or template](https://github.com/troxler/awesome-css-frameworks).
This should do the bulk of your styling/CSS for you and be appropriate to your application.
For example, don't use [NES.css](https://nostalgic-css.github.io/NES.css/) (which is awesome!) unless you're creating a game or some type of retro 80s site.

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

HTML:
- HTML input tags and form fields of various flavors (`<textarea>`, `<input>`, checkboxes, radio buttons etc.)
- HTML that can display all data *for a particular authenticated user*. Note that this is different from the last assignnment, which required the display of all data in memory on the server.

Note that it might make sense to have two pages for this assignment, one that handles login / authentication, and one that contains the rest of your application.
For example, when visiting the home page for the assignment, users could be presented with a login form. After submitting the login form, if the login is
successful, they are taken to the main application. If they fail, they are sent back to the login to try again. For this assignment, it is acceptable to simply create
new user accounts upon login if none exist, however, you must alert your users to this fact.

CSS:
- CSS styling should primarily be provided by your chosen template/framework.
Oftentimes a great deal of care has been put into designing CSS templates;
don't override their stylesheets unless you are extremely confident in your graphic design capabilities.
The idea is to use CSS templates that give you a professional looking design aesthetic without requiring you to be a graphic designer yourself.

JavaScript:
- At minimum, a small amount of front-end JavaScript to get / fetch data from the server.
See the [previous assignment](https://github.com/cs4241-19a/a2-shortstack) for reference.

Node.js:
- A server using Express, at least five pieces of Express middleware, and a persistent database (mongodb).

General:
- Your site should achieve at least 90% on the `Performance`, `Best Practices`, `Accessibility`, and `SEO` tests
using Google [Lighthouse](https://developers.google.com/web/tools/lighthouse) (don't worry about the PWA test, and don't worry about scores for mobile devices).
Test early and often so that fixing problems doesn't lead to suffering at the end of the assignment.

Deliverables
---

Do the following to complete this assignment:

1. Implement your project with the above requirements. A good potential starting point is to use the "hello-express" project template inside of Glitch; this appears as an option when you hit the "New Project" button. Use the work you did in the last assignment as a reference to implement functionality.
2. If you developed your project locally, deploy your project to Glitch (unless completing the alternative server technical acheivement described below), and fill in the appropriate fields in your package.json file.
3. Test your project to make sure that when someone goes to your main page on Glitch, it displays correctly.
4. Ensure that your project has the proper naming scheme `a3-yourfirstname-yourlastname` so we can find it.
5. Fork this repository and modify the README to the specifications below.
6. Create and submit a Pull Request to the original repo. Name the pull request using the following template: `a3-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, for a maximum twenty additional points and a maximum grade of a 100%.
These are recommended acheivements, but feel free to create/implement your own... just make sure you thoroughly describe what you did in your README,
why it was challenging, and how many points you think the achievement should be worth.
ALL ACHIEVEMENTS MUST BE DESCRIBED IN YOUR README IN ORDER TO GET CREDIT FOR THEM.

*Technical*
- (10 points) Implement OAuth authentication, perhaps with a library like [passport.js](http://www.passportjs.org/).
*You must either use Github authenticaion or provide a username/password to access a dummy account*.
Course staff cannot be expected, for example, to have a personal Facebook, Google, or Twitter account to use when grading this assignment.
Please contact the course staff if you have any questions about this. THIS IS THE HARDEST ACHEIVEMENT OFFERED IN WEBWARE. You have been warned!
- (5 points) Instead of Glitch, host your site on a different service like [Heroku](https://www.heroku.com) or [Digital Ocean](https://www.digitalocean.com). Make sure to describe this a bit in your README. What was better about using the service you chose as compared to Glitch? What (if anything) was worse?
- (5 points) Get 100% (not 98%, not 99%, but 100%) in all four lighthouse tests required for this assignment.

*Design/UX*
- (10 points) Make your site accessible using the [resources and hints available from the W3C](https://www.w3.org/WAI/), Implement/follow twelve tips from their [tips for writing](https://www.w3.org/WAI/tips/writing/), [tips for designing](https://www.w3.org/WAI/tips/designing/), and [tips for development](https://www.w3.org/WAI/tips/developing/). *Note that all twelve must require active work on your part*.
For example, even though your page will most likely not have a captcha, you don't get this as one of your twelve tips to follow because you're effectively
getting it "for free" without having to actively change anything about your site.
Contact the course staff if you have any questions about what qualifies and doesn't qualify in this regard.
List each tip that you followed and describe what you did to follow it in your site.
- (5 points) Describe how your site uses the CRAP principles in the Non-Designer's Design Book readings.
Which element received the most emphasis (contrast) on each page?
How did you use proximity to organize the visual information on your page?
What design elements (colors, fonts, layouts, etc.) did you use repeatedly throughout your site?
How did you use alignment to organize information and/or increase contrast for particular elements.
Write a paragraph of at least 125 words *for each of four principles* (four paragraphs, 500 words in total).

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

your glitch (or alternative server) link e.g. http://a3-charlie-roberts.glitch.me

Include a very brief summary of your project here. Images are encouraged, along with concise, high-level text. Be sure to include:

- the goal of the application
- challenges you faced in realizing the application
- what authentication strategy you chose to use and why (choosing one because it seemed the easiest to implement is perfectly acceptable)
- what CSS framework you used and why
- include any modifications to the CSS framework you made via custom CSS you authored
- the five Express middleware packages you used and a short (one sentence) summary of what each one does. If you use a custom function for *one* (and one alone) middleware please
add a little more detail about what it does.
## To Do List Generator

Frank McShan
http://a3-frank-mcshan.glitch.me

My web application is a to do list generator that lets users input a task, a creation date, and whether or not the task is a priority. After submitting, users can view all of their to dos in a convenient table. From there, they can modify or delete table entries. The goal of this application was to create an easy way for users to keep track and manage their tasks. A plus about the application is that it will sort entries based on the due date, allowing users to visualize tasks with sooner due dates more easily. I faced several challenges in realizing the application. A major challenge was figuring out how to save changes to individual table rows to the database. Another challenge was figuring out how to sort entries based on the date - this was completed using a sort function. The authentication strategy I chose was using cookies because it seemed to be the easiest to implement and understand as a whole. I used the CSS Bootstrap framework. I chose the framework because it makes web pages appear simple and easy to read. The color and font choices used throughout the framework are aesthetically pleasing and simple - it makes the application look more polished and professional. I used five middleware packages in this application. I used express.static() to serve static files, which includes my JavaScript file containing scripts for the application. I used express.json() to parse incoming requests with JSON payloads so that it would be easy to interact with incoming requests using the request body, rather than having to use JSON.parse() each time. I also used express.urlencoded() to parse incoming requests with urlencoded payloads, and the extended:true component was used to allow for rich objects and arrays to be encoded into the URL-encoded format. This was used for putting key-value pairs into an object for authentication. I used the built-in favicon middleware package to implement a custom favicon for my site of a Pride heart. Finally, I used cookie middleware to properly authenticate a user. The cookie has a session and keys associated with it, and they are then parsed into an object used by the server to validate a user's credentials.

## Technical Achievements
- **Tech Achievement 1**: I used OAuth authentication via the GitHub strategy
- **Tech Achievement 3**: I got a 100% in all four lighthouse tests required for this assignment.

### Design/Evaluation Achievements
- **Design Achievement 1**: I followed the following tips from the W3C Web Accessibility Initiative...
- **Design Achievement 1**: I followed the following tips from the W3C Web Accessibility Initiative:

-Provide clear instructions: I let users know when they have successfully created a new account and when a data row is updated, both through alerts using simple, easy-to-understand language.

-Keep content clear and concise: I followed this guideline by having all text on the application be simple and easy to read, while avoiding complex words and phrases.

-Provide sufficient contrast between foreground and background: I contrasted the black text and blue/red/green buttons throughout my application with a light gray background.

-Don't use color alone to convey information: I added text to all buttons to better indicate what they do, so that the user doesn't need to assume (ex. red button must mean delete).

-Ensure that interactive elements are easy to identify: I utilized distinct styles for my buttons using the Bootstrap CSS framework. All buttons have rounded corners, and the button colors correspond to their functionality (ex. green to save, red to delete).

-Provide clear and consistent navigation options: I made sure that the flow of users interacting with the application has consistent naming, styling, and positioning. All objects are centered and feature the same font, background color, text color, and button styling.

-Ensure that form elements include clearly associated labels: I added labels next to each element on both my login form and my form for submitting new to dos.

-Provide easily identifiable feedback: I provide feedback for certain user interactions, including when a new user account is created, and when the user saves changes to a particular data row via an alert.

-Associate a label with every form control: I associated a label with every form attribute.

-Identify page language and language changes: I indicated the primary language of every page by using the lang attribute in the html tag.

-Reflect the reading order in the code order: I ensured that the elements in the code match the order of the information presented. Initially, I had the form attributes presented on one line, and it would get almost jumbled in with the table. By re-organizing this layout, the code order reflects that of the reading order. To confirm this, I removed the CSS styling and saw the content order still made sense.

-Ensure that all interactive elements are keyboard accessible: When modifying data, all rows in the table were changed from labels to show up as input fields, allowing the user to tab and easily edit a particular field, and then tabbing over to the save button to which they can then press the enter key to save.
1 change: 1 addition & 0 deletions node_modules/.bin/is-docker

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

1 change: 1 addition & 0 deletions node_modules/.bin/mime

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

1 change: 1 addition & 0 deletions node_modules/.bin/node-which

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

1 change: 1 addition & 0 deletions node_modules/.bin/semver

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

1 change: 1 addition & 0 deletions node_modules/.bin/uuid

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

21 changes: 21 additions & 0 deletions node_modules/@types/node/LICENSE

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

16 changes: 16 additions & 0 deletions node_modules/@types/node/README.md

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

Loading