Facebook Clone

Table Of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Authors

About The Project

Introduction: https://docs.google.com/presentation/d/18l59u0hNWd3g6lJgNLsKxlMcukCjbKKA9eSortOCXck/edit?usp=sharing

Prerequisites

Things you need to use the software and how to install them.

• Visual Studio Code
• Dev Containers: ms-vscode-remote.remote-containers extension in Visual Studio Code
• Docker Desktop
• Follow https://support.google.com/appsheet/answer/10104995?hl=en to create a Firebase Account (Make sure you enable Email/Password Sign-in Method in your project)

Set up before running the project

1. Go to Firebase projects page > Select your project > Click Project Settings > Click on the Service accounts tab > Generate new private key

2. Name the downloaded file 'serviceAccountKey.json' and put the file in backend directory

3. Clone / Fork the repo

git clone https://github.com/ken999999999999999/facebook-clone.git

4. Create .env files and copy it from the .env.template in root, frontend & backend directories

5. Replace the following with your app's Firebase project configuration in frontend/.env

NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=

How to run the project locally

1. Open frontend/backend directory in VS code > press F1 and select

> Dev Containers: Rebuild and Reopen in Container

2. Navigate http://localhost:3000 in your browser

3. Enjoy!

See the open issues for a list of proposed features (and known issues).

Authors

• ken999999999999999 - ** - ken999999999999999 - **
• leunglong0123 - ** - leunglong0123 - **