Skip to content

Latest commit

 

History

History
264 lines (186 loc) · 8.41 KB

README.md

File metadata and controls

264 lines (186 loc) · 8.41 KB
Raw
logo

Messenger Clone

Messenger Clone: Next.js 13, React, Tailwind, Prisma, MongoDB, NextAuth, Pusher, (Message notifications and alerts, Tailwind animations and transition effects, File and image upload using Cloudinary CDN, File and image upload using Cloudinary CDN, Group chats and one-on-one messaging)

Documentation · Report Bug · Request Feature


📔 Table of Contents

🌟 About the Project

forthebadge forthebadge forthebadge

👾 Tech Stack

Client
Database

Google

🧰 Getting Started

‼️ Prerequisites

  • Install Node JS in your computer HERE
  • Sign up for a Cloudinary account HERE
  • Sign up for a Google Cloud Platform HERE
  • Sign up for a Meta for Developers HERE
  • Get Lookup APi Key HERE

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

DATABASE_URL

GOOGLE_CLIENT_ID

GOOGLE_CLIENT_SECRET

FACEBOOK_ID

FACEBOOK_SECRET

NEXTAUTH_SECRET

NEXTAUTH_URL

NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME

NEXT_PUBLIC_LOOKUP_KEY

⚙️ Installation

Install my-project with npm

npx create-next-app@latest my-project --typescript
cd my-project

Install dependencies

🧪 Install Tailwind CSS with Next.js

Install Tailwind CSS

Install tailwindcss and its peer dependencies via npm, and then run the init command to generate both tailwind.config.js and postcss.config.js.

npm install -D tailwindcss postcss autoprefixer
npx tailwindcss init -p

Configure your template paths

Add the paths to all of your template files in your tailwind.config.js file. 

module.exports = {
  content: [
    "./pages/**/*.{js,ts,jsx,tsx}",
    "./components/**/*.{js,ts,jsx,tsx}",
  ],
  theme: {
    extend: {},
  },
  plugins: [],
};

Add the Tailwind directives to your CSS

Add the @tailwind directives for each of Tailwind’s layers to your ./styles/globals.css file.

@tailwind base;
@tailwind components;
@tailwind utilities;

Install dependencies

🔶 Other Dependency Info

🏃 Run Locally

Clone the project

  git clone https://github.com/SashenJayathilaka/Messenger-Clone.git
cd Messenger-Clone

Install dependencies This is a Next.js project bootstrapped with create-next-app.

  npm install

Start the server First, run the development server:

  npm run dev

This is a Next.js project bootstrapped with create-next-app.

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

🚩 Deployment

To deploy this project run

Deploy on Vercel

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

🤝 Contact

Your Name - @twitter_handle - sashenjayathilaka95@gmail.com

Project Link: https://github.com/SashenJayathilaka/META-Messenger-Clone.git