Read-it FE

---

📝 Table of Contents

• About
• Screen Video from the Website and features
• Drive Link
• Project setup
• Contributors

About

• A Project that mimics the Frontend part of reddit.

Screen Video from the Website and features:

🔒 User Authentication

• Login using Google
• Login using Facebook
• Signup
• Login
• Forget password
• Forget username
• Change password

SW1.mp4

SW1.mp4

---

🙍‍♂️ User Profile

• Profile overview (posts, comments, upvotes, downvotes, etc.)
• Your Posts
• Your Comment
• Your Upvotes
• Your Downvotes
• Your Saved Posts and Comments
• Your Hidden Posts and Comments
• Your History
• Your Followers

SW4.mp4

SW4.mp4

---

🌐 Community(subreddit)

• Community overview (posts, comments, upvotes, downvotes, etc.)
• Community Posts
• Community Comment
• Community categories
• Top Communities

SW7.mp4

SW7.mp4

---

📰 Post

• Create rich text post
• Create image and video post
• Create link post
• Add flair to post
• Add spoiler to post
• Add nsfw to post
• Upvote and downvote post
• Save post
• Hide post
• Share post
• Edit own post
• Delete own post
• Lock own post

SW3.mp4

SW3.mp4

---

🔎 Search

• Search by post
• Search by comment
• Search by community
• Search by people

SW9.mp4

SW9.mp4

---

🗨️ Comment

• Create rich text comment
• Nested comments up to any level
• Upvote and downvote comment
• Reply to comment
• Edit own comment
• Delete own comment
• Lock own comment

SW2.mp4

SW2.mp4

---

🔔 Notifications

• Push notifications
• All notifications

---

✉️ Messages

• Send a private message
• All messages
• Unread messages
• Sent messages
• Post replies
• Usernames mentions
• Delete message
• Spam message
• Reply to message

SW6.mp4

SW6.mp4

---

🤵 Moderator

• Queues
  • Spamed (posts only, comments only, posts and comments)
  • Edited (posts only, comments only, posts and comments)
  • Unmoderated (posts only, comments only, posts and comments)
• User management
  • Banned users
  • Muted user
  • Approved user
  • Moderators
• Flairs and emojis
  • Add new flair
  • Edit flair
  • Delete flair
  • Reorder flairs
• Rules and regulations
  • Add new rule
  • Edit rule
  • Delete rule
  • Reorder rules
• Community settings
  • Edit community name
  • Edit community description
  • Edit community topic
  • Edit community language
  • Edit community type (Public, Private, Restricted)
  • Edit community region
• Posts & Comments settings
  • Enable/disable community Spoiler tag
  • Edit suggested sort for posts
  • Enable/disable image in posts
• Community traffic
  • Day of week
  • Month
  • Page views
  • Members joined
  • Members left

SW8.mp4

SW8.mp4

---

⚙️ User Settings

• Account setting
• Profile setting
• Email setting
• Safety and privacy setting
• Feed setting

SW5.mp4

SW5.mp4

---

## Main commands for running the Project: ### Project setup & installing packages

npm install

Compiles and hot-reloads for development

npm run serve

Runs the project by default on port:8081

Compiles and minifies for production

npm run build

The project is found in a /dist folder under the same directory after building

Run your unit tests

npm run test

This command runs all the unit tests.

Generating coverage report

npm run coverage

This command generates a coverage report index.html including details about all components The generated coverage report is found in the project directory under /coverage

Run mock server

npm run json

Runs on port:3000

Generate Functional documentation report

vuese gen

To generate the report under /website folder in the project directory

Generate Functional documentation report for store

npm run jsdoc

To generate the report under /out folder in the project directory

Lints and fixes files

npm run lint

Prettier files and fixes it

npm run prettier

Contributors

Asmaa Adel

Menatalh Hossamalden

norhan reda

HodaGamal

abdalhamedemad

Karim Saqer