Skip to content

Commit 8053004

Browse files
authored
Update README.md
Signed-off-by: Puskar Roy <[email protected]>
1 parent df0aed1 commit 8053004

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,58 @@
5050
</ol>
5151
</details>
5252

53-
53+
## 🛠️ Prerequisites
54+
55+
- [Node.js](https://nodejs.org/) installed on your machine 🟩
56+
- [Git](https://git-scm.com/) installed on your machine 🐙
57+
58+
## ⚙️ Installation
59+
60+
### 1. Run This Command:
61+
62+
```bash
63+
npx lets-create-api <file-name>
64+
```
65+
<img src="https://res.cloudinary.com/dt0hbetuq/image/upload/v1701715229/rtl3x5ct8ak7u4zc6rv6.jpg" alt="Logo" width="560" height="140">
66+
<p>🚀 This command will initialize your API project with a specific file name.</p>
67+
<br/>
68+
69+
### 2. Choose your tech stack:
70+
71+
<img src="https://res.cloudinary.com/dt0hbetuq/image/upload/v1701715254/jblqytt9sjmyetudjqhy.jpg" alt="Logo" width="590" height="150">
72+
<p>⚙️ Select your preferred technology stack to tailor your API project.</p>
73+
<br/>
74+
75+
### 3. Choose your Database:
76+
77+
<img src="https://res.cloudinary.com/dt0hbetuq/image/upload/v1701715264/b3ilvo4zjftdrasjigrh.jpg" alt="Logo" width="590" height="150">
78+
<p>🛢️ Pick the database technology that suits your project needs.</p>
79+
<br/>
80+
81+
### 4. This Will Create A Folder For Your Template:
82+
83+
<img src="https://res.cloudinary.com/dt0hbetuq/image/upload/v1701715274/jolv47jd3vz3cdd86aoi.jpg" alt="Logo" width="590" height="260">
84+
<p>📁 The CLI will create a dedicated folder for your selected template.</p>
85+
<br/>
86+
87+
### 5. If you want to push your code in github make it "y":
88+
89+
<img src="https://res.cloudinary.com/dt0hbetuq/image/upload/v1701715282/oa8iwsm4kaxhsbhkecio.jpg" alt="Logo" width="590" height="150">
90+
<p>💻 If you wish to push your code to GitHub, type "y" and follow the prompts.</p>
91+
<br/>
92+
93+
### 6. Now Create an empty Repo and paste link here :
94+
95+
<img src="https://res.cloudinary.com/dt0hbetuq/image/upload/v1701715325/glndqajvqg3nf5nv5gha.jpg" alt="Logo" width="590" height="150">
96+
<p>🔗 Provide the link to the empty repository you created on GitHub.</p>
97+
<br/>
98+
99+
### 7. Now It will push all code in your repo and you are all set:
100+
101+
<img src="https://res.cloudinary.com/dt0hbetuq/image/upload/v1701715360/isv6qvzdhf7n2ekdfttu.jpg" alt="Logo" width="590" height="250">
102+
<p>✅ The CLI will push all code to your GitHub repository, and your API project is ready to go!</p>
103+
<br/>
104+
54105
## About The Project
55106

56107

@@ -68,3 +119,7 @@ Creating APIs has never been this flexible and straightforward! The CLI For Crea
68119
Of course, This template may not cover all project needs, as your requirements may vary. More updates will be added in the future. Feel free to suggest changes by forking this repo, creating a pull request, or opening an issue. Thanks to all contributors who have helped enhance this template!
69120

70121
<p align="right">(<a href="#readme-top">back to top</a>)</p>
122+
123+
124+
125+

0 commit comments

Comments
 (0)