Hi everyone, welcome to our web application: Help. Help is a hypertext system inspired by Yelp, a service that publishes user reviews and recommendations for restaurants.
The overarching goal of our project is to build upon the existing hypertext features from the entirety of this course to develop a user-friendly restaurant review system.
From the root directory, cd into either server or client
and then run the following commands:
Installs all of MyHypermedia's dependencies.
Creates a .env file for you to set up.
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
I chose to do Graph Visualization and Search as my additional features.
The use case that I am addressing is students asking questions for a CS course -- similar to EdStem.
The features suitable for my use case are:
- Various text headings
- Bold
- Code Snippet
- Code Block
- Bullet list
- Italic
- Strike
These features are important since students will need to ask code-related questions for debugging purposes. Thus, the text editor must be able to support code blocks and formatting to make code readable. Additionally, students may ask several questions at a time so it would be important to have a bullet list for organization. Having a strikethrough is also a nice addition to indicate what questions have been answered, and various heading formatting to show importance of questions.
I choose to crop my image when resizing, which is exactly what the demo does. Students sometimes screenshot their code so it would be nice for them to be able to crop the screenshot to just show the case. There is a button on the left of the height and width for resetting the image back to its original normalized dimensions, with an intuitive icon.
For the text, I chose to have a save button to save the editor content. The save button is also a different shade of color to make it appear more clearly for the user.
https://calm-mesa-01359.herokuapp.com/
https://calm-mesa-01359.web.app/
I am not doing any extra credit for this assignment.
There are no known bugs.
40 Hours