howdidigithere / peroos

Reddit Clone

peroos

Try it out! Peroos

Peroos, a Reddit clone, is a social media application that allows its users to connect with each other based on shared interests

Fuctionality and MVPs

• Visit communities
• View posts and their comments
• Sign Up to:
  • Create your own communities
  • Follow communities
  • Leave posts and comments
  • Edit/Delete your posts and comments
  • Up/Down vote posts and comments
• Search for specific communities by name

Features to be Implemented

• Detailed User profile pages
• Add AWS to store images for user/community pictures
• Live direct chat functionality

Technologies

Backend

• Ruby on Rails
• PostgreSQL
• jBuilder

Frontend

• React
• Redux
• Node.js
• jQuery

Feedback

If you find any bugs or think of any features that would be nice to have feel free to shoot me an email at [email protected] or file an issue! Any feedback is appreciated, so don't be shy!

Acknowledgments

• All icons seen on Peroos were from FontAwesome and Flaticon, so check them out!
• If some seed communities or posts look familiar, that's because they are! A handful of communities and posts from Reddit were used to populate the site. The communities that were are as follow:
  • nba
  • LifeProTips
  • cscareerquestions
  • explainlikeimfive
  • writing
  • TrueOffMyChest

peroos's Issues

Design Doc Checklist

Wiki Page Home

• Is the first page you see upon entering the wiki
• Contains a welcome message
• Contains a description sentence of the app
• Contains a link/placeholder for a link to the live page
• All links in the right sidebar should contain each wiki page and link to the correct page
• Correctly formatted
  • each wiki page is listed in bullet points
  • all links route the correct page

---

MVP List

• Should have 7 MVPs.
  • 3 of those are User Auth, Heroku, and Production README.
  • The other 4 are from the MVP List or they have clarified them with you
• Includes two to three detailed bullets on functionality and presentation of feature
• At least one CRUD feature, which states what CRUD operations are planned (creation, reading, updating, deletion)
• Estimates how long it will take the code each MVP
• Correctly formatted
  • MVPs are listed in an ordered list
  • Each MVP is broken down into bullet points

---

Database Schema

• Contains correct datatypes
• Contains appropriate constraints/details (primary and foreign keys, not null, indexed, unique)
• Contains bullet points after the table that state which foreign keys will reference to which table, or references to the associations which will be made
• Correctly formatted
  • schema is written in a table format
  • table names, column names, and foreign keys are lowercased, snake_cased and back_ticked
  • the table header column names are bolded

---

Sample State

• State shape is flat!
• State's keys are camelCased
• All keys within the values in the state are accessible in the schema
• Correctly formatted
  • Sample state is rendered with triple backticks, and the language ```javascript...```). This will display the state as a code block instead of a giant line of text
  • Top level slices
    • entities
    • session
    • errors (here or in ui)
    • ui (if needed)
  • Should NOT have nested slices, aka comments inside of posts
    • Some info from other tables is ok, for instance:
      • the author username and imageurl for a post. basically any info that the user can't change
      • like count and a boolean on whether the user likes the post instead of a likes slice

---

Backend Routes

• Contains the following sections: HTML, API Endpoints(Backend)
• Each route has a description
• API Endpoint routes contains wildcard variables written in snake_case
• Routes does not contain superfluous routes
• Have API routes that will allow the front end to get all info it needs and does not have unneeded routes:
  • probably doesn't need a GET likes api endpoint because that info comes through the post show

---

Frontend Routes

• Frontend routes contains wildcard variables written in camelCase
• Correctly formatted
  • Routes are displayed with inline coding text (backticks)