cosmoEagle/leetcode-api

1# Wanna Contribute 🤔??2 3## With Docker 🐳4 5- #### 🍴 Create a Fork of this Repo to Your GitHub Account6 7  ![Alt text](./public/demo/contribute.png)8 9- #### 🧑🏽‍💻 Clone Your Repo Locally10 11  first open your CLI and clone the repo locally. But don't forget to replace **username** with your GitHub username12 13  ```bash14  git clone https://github.com/username/alfa-leetcode-api.git15  ```16 17- #### 👋🏽 Go to the Project Folder18 19  ```bash20  cd alfa-leetcode-api21  ```22 23- #### 🚀 Start the Project with Docker24  ```bash25  docker compose up26  ```27 28## Without Docker 🐳❌29 30- #### 🍴 Create a Fork of this repo to Your GitHub Account31 32  ![Alt text](./public/demo/contribute.png)33 34- #### 🧑🏽‍💻 Clone Your Repo Locally35 36  first open your CLI and clone the repo locally. But don't forget to replace **username** with your GitHub username37 38  ```bash39  git clone https://github.com/username/alfa-leetcode-api.git40  ```41 42- #### 👋🏽 Go to the Project Folder43 44  ```bash45  cd alfa-leetcode-api46  ```47 48- #### 🚀 Install Required Modules49 50  ```bash51  npm install52  ```53 54- #### 🏃🏽‍♂️Run the Project Locally55 56  ```bash57  npm run dev58  ```59 60##61 62- #### 💡 Make Changes & Create Pull Requests63 64  Make changes as needed and push them to your GitHub repository with proper **commit message**. From there, create a **PR (Pull Request)** and submit it.65 66- #### 📌 Additional Tip67 68  Try to create a new branch relevant to your work. For example - `fix:xyz-issue`69 70  📝Note - It's not Necessary for contribution but it will help me to merge it.71 72#73 74#### 📌 Special Thanks to [@sazsu](https://github.com/sazsu) for improving the documentation75