Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 4.71 KB

README.md

File metadata and controls

87 lines (52 loc) · 4.71 KB
Raw

logo

Dependencies React GitHub Issues GitHub license

Basic Overview

PostOShare is a social media app where registered users can post posts and comments. The app uses React as the UI render and Firebase as the database.

Installation

The lastest version of PostOShare can be installed by npm.

    git clone https://github.com/aditya1962/PostOShare.git
    
    cd PostOShare
    
    npm install 
    
    npm start

Database

PostOShare uses Firebase realtime database. Database is hosted at https://social-media-post.firebaseio.com. Configuration details are implemented in firebase.js.

...
var config = {
    apiKey: "AIzaSyC0x7BDINL1BvNA_sKWK7Zr4YojFdePEik",
    authDomain: "social-media-post.firebaseapp.com",
    databaseURL: "https://social-media-post.firebaseio.com",
    projectId: "social-media-post",
    storageBucket: "social-media-post.appspot.com",
    messagingSenderId: "136183787820"
  };
...

The initial database is exported and hosted as database-export.json in the root directory.

Basic Usage

PostOShare requires users to be logged in to continue. Therefore, a user should first register at the Register page.

Once registered a user can either login or change the password.

Login

Fig 1: Login

Confirm Password

Fig 2:Confirm Password

Since PostOShare currently does not use a server environment for server side processing, a confirmation mail is not currently sent to the user. Also, the username of a username CANNOT be changed once registered.

An authorized user will be redirected to the Home component. Here the user has the ability to post posts and comments.

Add Post

Fig 3: Add Post

An authorized user also has the ability to edit posts and/or comments posted by them. If a post is edited an Edited flag will be shown on top of the time.

Edit Post

Fig 4: Edit Post

The left side panel displays details of the user. These will be set only after the user has edited their profile.

To edit a profile, hover over the profile icon at the top row and click Edit Profile.

Edit

Fig 5: Edit Profile

The Edit Profile component is divided into two sections: login related data and user related data. Once all the data are filled the user can edit the profile. Currently, PostOShare does not allow uploading a profile picture. Therefore, the profile picture will be set to default.

A user can log out of the application by hovering over the profile icon at the top row and clicking Logout

Contributing to PostOShare

Contributing guidelines to PostOShare can be found in contributing to PostOShare

License

PostOShare uses MIT license.