Instanews

Table of Contents

• About the Project
  • Build with
• Getting Started
  • Installation
  • Running
• Screenshots
• Responsive Sreenshots
• File Structure
• Contributing
• Contributors
• BackLog
• License

Important Note

I am still working on the project, this is not the final verison of it, I just make it public to get feedback and imporve it ... Happay-Eid 🎉🐏

About

Instanews is a fully responsive social media app that is a mimic for Instagram built using Vuejs.

Build with

• Vue JS
• BEM Methodology
• Vuex
• Firebase
• Bootstrap
• Jest
• Axios

Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructuins.

Installation

1. Clone the repository

$ git clone https://github.com/AbdallahHemdan/Instanews.git

2. Navigate to repository directory

$ cd Instanews

3. Install dependencies

$ npm install

Running

1. Compiles and hot-reloads for development

$ npm run serve

2. Compiles and minifies for production

$ npm run build

3. Run unit tests

npm run test:unit

File Structure

Instanews
├── README.md
├── LICENSE
├── package-lock.json
├── package.json
├── jest.config.js
├── backlog.md
├── babel.config.js
├── .gitignore
├── .browserslistrc
├── tests
│   └── unit
├── src
│   ├── assets
│   ├── components
|   |   ├── Comments
|   |   ├── InboxContainer	
|   |   ├── LeftAuth	
|   |   ├── MessageItem	
|   |   ├── MessagesContainer	
|   |   ├── Navbar	
|   |   ├── Newsfeed	
|   |   ├── NotificationItem	
|   |   ├── NotificationsDropdown	
|   |   ├── OrDivider	
|   |   ├── Post	
|   |   ├── PostAction	
|   |   ├── PostDescription	
|   |   ├── ProfileDescription	
|   |   ├── ProfileDropdown	
|   |   ├── ProfileGallery	
|   |   ├── ProfileGalleryItem	
|   |   ├── ProfileHeader
|   |   ├── ProfileStories
|   |   ├── ProfileUpperHeader
|   |   ├── SingleComment
|   |   ├── SingleSuggestion
|   |   ├── SuggestionHeader
|   |   ├── UserInfo
|   |   ├── UserSuggestions
|   |   └── ProfileHeaderTitle
│   ├── mock
│   ├── router
│   ├── store
│   ├── style
│   ├── views
|   |   ├── Chat
|   |   ├── Explore
|   |   ├── Forget Password
|   |   ├── Home
|   |   ├── Liked
|   |   ├── Login
|   |   ├── Signup
|   |   ├── NotFound
|   |   └── Profile
│   ├── main.js
│   └── App.vue
├── public
│   ├── favicon.ico	
│   └── index.html	
├── node_modules
└── CONTRIBUTING.md	

Screenshots

Home Page

---

---

---

---

---

Profile Page

---

---

---

---

---

---

---

---

Explore Page

---

---

Inbox Page

Notifications Dropdown

---

404 Page

Login Page

---

Auth with Google, Facebook and Github

Signup Page

Forget Password Page

Responsive Screenshots

---

---

---

---

---

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Check out our contributing guidelines for ways to contribute.

Contributors

Thanks goes to these wonderful people in the frontend team.

Abdallah Hemdan🎯💻👀

BackLog

• Connect Instanew with firebase to provide authentication (login-signup)
• Handle auto redirect in different cases (user logged in and trying to visit login/signup pages | user is not logged in and trying to visit any page)
• Create auth with (Google - Facebook - Github)
• Handle form validation for (Login - Signup - ForgetPassword)
• Create chat-module for inbox-page
• Integrate Search module with firebase
• Add Stories section in home-page
• Enable uploading stories, write comments, Edit profile
• Create modal for posts (when user click the post the modal popup)
• Create modals for following, followers in profile-page
• Create modals for see all suggested users
• Replace scrolling bar in user suggestions section to (left) and (right) arrow
• Create suggestion component
• Fix naming convension to follow BEM Methodology
• Dynamically render posts or tagged in profile
• Enable CTAs for notifications

License

This software is licensed under MIT License, See License for more information ©AbdallahHemdan.