From ab8327ed5e2f360c1d35c7ef6b0d866f5d0a4a61 Mon Sep 17 00:00:00 2001 From: subhamagarrwal <130570909+subhamagarrwal@users.noreply.github.com> Date: Fri, 11 Oct 2024 17:19:29 +0530 Subject: [PATCH] Update CONTRIBUTING.md added the installation process prior to the contributing section(running on localhost+running on Docker) --- CONTRIBUTING.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76bdede..82ee93e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,62 @@ +**Before contributing to the repository, here are a few steps you can follow to understand the project** + +## Installation +For Installation on local machine follow bellow steps: +First [fork the reqpository](https://github.com/Suraj-kumar00/Flash-Fathom-AI/fork) + +```sh +git clone https://github.com/your-username/Flash-Fathom-AI/ +cd Flash-Fathom-AI +``` +## Install the dependencies +**The package manager** +```sh +npm install -g pnpm +``` +**Install pnpm pakcage manager** +```sh +pnpm install +``` + +If required for you: +**Installing clerk** +```bash +pnpm add @clerk/clerk-sdk @clerk/nextjs +``` + +**OpenAI** +```bash +pnpm add openai +``` + +**Firebase** +```bash +pnpm add firebase +``` +**Stripe** +```bash +pnpm add @stripe/stripe-js +``` +**Shadcn UI** +```bash +pnpm add @shadcn/ui +``` + +## Running the project using Docker +First Install [**Docker Desktop**](https://www.docker.com/products/docker-desktop/) + +**Pull the image** +```bash +docker pull surajkumar00/flashfathom-ai +``` +**Run the Container** +```bash +docker run -it -p 3000:3000 surajkumar00/flashfathom-ai +``` +**Check localhost** +[localhost:3000](localhost:3000) + + ## 🫱🏼‍🫲🏻 Contributing We welcome contributions to enhance the AI Customer Support system! To contribute: