Read-it FE

---

📝 Table of Contents

• About
• Screen Video from the Website
• website Features
• Drive Link
• Project setup
• Contributors

About

• A Project that mimics the Frontend part of reddit.

Screen Video from the Website:

Login

SW1.mp4

Add Comment

SW2.mp4

Create Post

SW3.mp4

User Page

SW4.mp4

User Settings

SW5.mp4

Messages and Notifications

SW6.mp4

Leadeboard and Subreddit Page

SW7.mp4

Moderation Page

SW8.mp4

Searching and Share Post

SW9.mp4

Drive Link:

https://drive.google.com/drive/folders/1hYpEu922aeDHHsKUyx9lVgx0AeykMJJg

website Features:

• Authentication
• Create, update, share and delete posts and comments.
• create all types of post(text, link, drag and drop one image or more, drag and drop video).
• Upvote/downvote posts and comments.
• Nested comments threading.
• Home page feed (front page).
• Subreddit specific feed.
• Create subreddits.
• Join subreddits.
• Add ban, mute, approve, and invite user to be a moderator of my subreddit.
• Accept invitation of user to become moderator.
• See trafic status o my subreddit.
• view my posts, comments, history, ... in my page.
• change my avatar, and add banner.
• ... and more!

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