Project MeTalk🚀

Making online conversations simpler

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Future Updates

About The Project

Homepage

The aim of Project MeTalk is to make the interaction of people throught out the world more convenient, hassle-free and in more customized way. This platform is built while keeping in mind the easiness and security of the people's data and their use-case.

👨‍🔧 Here's all the services provided:

👨 Login / Register using Firebase

💪 Public and Private rooms

📂 Media Sharing

🙋‍♂️ Typing and Presence Indicators

Built With

Getting Started

Follow these simple steps to run the project locally:

Prerequisites

• Node.js (latest)
• NOTE - Make sure you have yarn in your path variables because I've used yarn for this project

Installation

1. Create an account on Firebase if you have not yet.

2. Refer this link to learn basics of firebase, like how to setup project in React and stuff like that.

3. Create a .env file in the root directory of the project. Add environment-specific variables on new lines in the form of NAME=VALUE by following same structure as provided in env.example file

      REACT_APP_API_KEY=<api_key>
      REACT_APP_AUTH_DOMAIN=<auth_domain>
      REACT_APP_PROJECT_ID=<project_id>
      REACT_APP_STORAGE_BUCKET=<storage_bucket>
      REACT_APP_MESSAGING_SENDER_ID=<sender_id>
      REACT_APP_APP_ID=<app_id>
      REACT_APP_MEASUREMENT_ID=<measurement_id>

4. Install all the dependencies of package.json file by running below command in root directory.

   yarn
   

5. Run the following command in the root directory to start the project

   yarn start
   

🥳Viola! Project starts running at localhost:3000

Future Updates

• Enable PWA
• Sticker Bar
• Improve Overall UI/UX and fix bugs
• Responsive Design

And More! There's always room for improvement!