jvt / shush.it Goto Github PK

Was thinking something based on Google's Material Design but still not decided.

Programmers on the Internet love to talk about how nice it is when "all their tests pass" but unfortunately contributors to this project won't know what that feels like because there are no tests to pass. That should be fixed.

Spacing between the "Created By" card and the "Install/Preview" card is not consistent with the rest of the page.

The mdl-layout__content div spans the entire height of the page and covers the <footer> element. Given that the <footer> element is below the mdl-layout__content div in the DOM, none of the links on the footer are clickable.

When a user clicks on the "Add to Tweetbot" link anywhere on the site, the user will be redirected to a middleware page (/install/xxx/) as a way to track who installs filters and the number of times a filter has been downloaded.

No ephemeral data needs to be stored, an RDBMS would likely be the most appropriate tool.

Tables:

• Users
  • Twitter User ID
  • Twitter screen name
  • Twitter name
• Filters
  • Owner
  • Title
  • Description
  • Type (regex, keyword)
  • Pattern
• Filter Export (used to track popularity of filters)
  • Filter exported
  • Filter exporter
  • Date added

Makes developing Twitter-facing code a bit difficult.

When a user clicks on the "Shush.it" logo in the navigation header, it only highlights since it's just text. A more reasonable UX would be to link back to the homepage.

Need to JOIN filters.owner with users.id.

Add a way for logged in users to submit a new filter to the database.

Currently the only validation is a character counter displayed below the bars on the /filter/new page. Server-side validation is a necessity.

A GruntFile.js is required for Grunt to provide any value. We should also switch over to using CSS-preprocessor SASS for more legible CSS files.

On page load, the <header> element does a brief jump while waiting for the style.css file to load over the network.

After a user clicks the "Add to Tweetbot" button, the button should change state to indicate to the user that it has been successfully installed.

There is no way for a user to log into their Twitter account unless they explicitly visit the /auth/twitter URL.

When browsing to a filter link that doesn't exist, the program just loads indefinitely rather than failing to a 404 error message.

The mobile sidebar navigation doesn't display a login link, your account that you're logged in with, or a signout link.

The search bar is a little hard to see in the current UI design and when the user has focus on it, there is no feedback to indicate so. A material-design-esque bar should appear along the bottom and there should be a circle-wave when the user clicks on it.

Present the user with tabs for their timeline and mentions which preview what each would look like when a filter is applied.

The navigation header should have a search bar or a button for a user to be able to search for filters.

The Install route does not check the filter type and always tells Tweetbot the filter is for Regex.

The search.js file never hits the database and just returns a static view file.

The MDL javascript code prevents the navigation's <a> tags from functioning as proper <a> tags (changing the URL) and instead are used to show/hide elements on the same current page with a corresponding id. This will not work for our planned architecture of the site.

Since this project is essentially only useful to Twitter users, OAuth authentication against twitter might be a good idea.

• Obtain Twitter OAuth tokens
• Add Twitter OAuth library to project
• Build routes for session management

Every redirect to a /install/ page should be logged to the database so the home page can generate most downloaded data.

On pages with content that is longer than the height of the window, the footer is stuck behind the content at the bottom of the window (figure 1).

On pages with content that is substantially smaller than the height of the window, the footer is at the proper positioning (figure 2).

It's important this works perfectly for both cases.

There is no way for a logged-in user to submit a new filter without navigating directly to the URL /filter/new/.