una-ada / xylem Goto Github PK

Users should be able to submit text content using Markdown notation that is then parsed by the server. This means holding both a contentRaw and a content field in any relevant models (User, Post, Comment).

I'm not entirely sure how to go about this one re: storage, but users should be able to upload images. Images should be stored with multiple sizes, for usage in different views.

See the Image model in the ERD

A users profile should have a biography and a profile image. There may also potentially be a need to add in external profile links for a user, e.g. personal website, Twitter profile, Instagram profile, etc.

While tagging a user is a good way to mention them publicly, private discussions would be a useful extension to user interaction.

Use Google's OAuth credentials to create users and their sessions. Handle this with Passport's Google strategy and express-session.

• Get Google People API credentials
• Install express-session
• Install PassportJS
• Install Passport Google strategy
• Configure Passport
• Define authentication routes
  • OAuth login route GET /oauth/google
  • OAuth callback route GET /oauth/continue
  • Logout route GET /logout
• Add login view
• Add logout view

Other users should be able to interact with a user's post, though "Like"s and "Comment"s. Likes should be a simple subdocument to assign ownership of the like (at the moment this is only for the liking user to verify their interaction) whereas comments need both ownership and Content.

See the Like and Comment embedded documents in the ERD.

The client should load data from the server to render pages and be styled (like, at all).

Within a post or comment, one User should be able to tag another User, like "@" to include that user in the conversation or credit them for work that was used.

This would require enhancement of the Post model as well as additional Notifications.

When one User interacts with another User's posts, the latter user should be notified so they can address any Comments or just feel the validation from receiving Likes.

See the Notification model in the ERD

Users should be able to follow each other and see an aggregate stream of all posts by followed accounts on their "dashboard" or "index" page.

See the Follow model in the ERD, though this may simply be a subdocument/embed on the User model.

So that preprocessors and the like can be easily implemented without any overhead in production, Grunt should be added as a dev workflow going forward.

• Add Grunt
• Add JSDoc
• Add JSDoc to Grunt
• Add Dart Sass
• Add Dart Sass to Grunt
• Add Watch to Grunt

For users registering through Google, which will be the default at the moment so as to not deal with implementing password hashing, account information may be taken from the Google account, but won't necessarily match the User's desired presentation on the site. Adding a settings page, and possibly an additional form on OAuth callback for registrations, will aid the user in customizing their account.

This is the key baseline functionality of the site. Posts should be able to be created by the user, displayed on the user's profile/"blog", and edited by the user who created it.

For now, posts simply need to have a Title and Content, see the Post model in the ERD