README.md

RabiBook

Table of Contents

• Features
• Demo
• Tech Stack
• Run Locally
• License
• Disclaimer
• Useful Links

Features

• An user can follow other users
• User can like a post and can comment on a post
• Search user using their username

Demo

You can create an account at RabiBook to explore or use the below credentials to Sign-in.

Demo Credentials

• Email: [email protected]
• Password: test12345

Tech Stack

• React-Redux
• Redux-Toolkit
• Firebase
• React Bootstrap

Run Locally

Prerequisites

To run this project locally one should have -

• A Firebase project created (Refer Firebase Docs for more)

Get the repo

Download the .zip file from Github or run the below command to clone the repo locally.

git clone https://github.com/tuhindas30/rabibook.git

Install dependencies

After cloning the repo, run the following command to install the project dependencies:

yarn install

Set environment

Set the environment variable in .env file at root directory. .env.sample file is given an a template.

REACT_APP_BASE_URL=http://localhost:3000
REACT_APP_FIREBASE_CONFIG=firebase_config_object_stringified

Run

yarn start
# Redux App will start at PORT 3000

License

RabiBook is MIT licensed.

Disclaimer

While deploying this project to production, please keep in mind that the project is in a very basic stage and may have severe bugs and vulnaberities.

Useful Links

• React Redux
• Redux Toolkit
• Firebase
• React Bootstrap