Skip to content

Commit

Permalink
update contribution file 📄
Browse files Browse the repository at this point in the history
alfaarghya committed Jun 30, 2024
1 parent 5852114 commit ef395c3
Showing 2 changed files with 36 additions and 7 deletions.
37 changes: 30 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,31 @@
### Wanna Contribute 🤔??
# Wanna Contribute 🤔??

## With Docker 🐳

- #### 🍴 Create a Fork of this repo to your GitHub Account

![Alt text](./public/demo/contribute.png)

- #### 🧑🏽‍💻 Clone the Your Repo Locally

first open your CLI and clone the repo locally. But don't forget put your github username in **username**

```bash
git clone https://github.com/username/alfa-leetcode-api.git
```

- #### 👋🏽 Go to the project folder

```bash
cd alfa-leetcode-api
```

- #### 👋🏽 Go to the project folder
```bash
docker compose up
```

## Without Docker 🐳❌

- #### 🍴 Create a Fork of this repo to your GitHub Account

@@ -30,6 +57,8 @@
npm run dev
```

##

- #### 💡 Make Changes & Pull Requests

Make changes as require and push it to your GitHub with proper **commit message**. From their Create a **PR(Pull Request)** and submit it.
@@ -41,9 +70,3 @@
📝Note - It's not Necessary for contribution but it will help me to marge it.

#

### Discuss Here 💬

[![Discord](https://img.shields.io/badge/discord-%2320232a.svg?style=normal&logo=discord&logoColor=%230077B5)](https://discord.gg/GJ6YM4zrBt)

#
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -31,10 +31,16 @@ https://alfa-leetcode-api.onrender.com/
docker run -p 3000:3000 alfaarghya/alfa-leetcode-api:2.0.1
```

## Wanna Contribute 🤔??

follow this documentation => <a href="CONTRIBUTING.md" target="_blank">CONTRIBUTING.md</a>

### 💡 Rate Limit

I've implemented a rate limit to prevent any potential server overload issues.

### ‼️ Note

During development, it's recommended to utilize the API locally. To do so, follow this documentation => <a href="CONTRIBUTING.md" target="_blank">Local Deploy</a>

## Endpoints 🚀

0 comments on commit ef395c3

Please sign in to comment.