Skip to content

Commit

Permalink
Merge pull request #5 from subhamagarrwal/patch-2
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md
  • Loading branch information
Suraj-kumar00 authored Oct 11, 2024
2 parents ca78aa4 + ab8327e commit 2ca0279
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit 2ca0279

Please sign in to comment.