diff --git a/README.md b/README.md index a7b122a..16c59f3 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,58 @@ - +## 🛠️ Prerequisites + +- [Node.js](https://nodejs.org/) installed on your machine 🟩 +- [Git](https://git-scm.com/) installed on your machine 🐙 + +## ⚙️ Installation + +### 1. Run This Command: + +```bash + npx lets-create-api +``` + Logo +

🚀 This command will initialize your API project with a specific file name.

+
+ +### 2. Choose your tech stack: + + Logo +

⚙️ Select your preferred technology stack to tailor your API project.

+
+ +### 3. Choose your Database: + + Logo +

🛢️ Pick the database technology that suits your project needs.

+
+ +### 4. This Will Create A Folder For Your Template: + + Logo +

📁 The CLI will create a dedicated folder for your selected template.

+
+ +### 5. If you want to push your code in github make it "y": + + Logo +

💻 If you wish to push your code to GitHub, type "y" and follow the prompts.

+
+ + ### 6. Now Create an empty Repo and paste link here : + + Logo +

🔗 Provide the link to the empty repository you created on GitHub.

+
+ +### 7. Now It will push all code in your repo and you are all set: + + Logo +

✅ The CLI will push all code to your GitHub repository, and your API project is ready to go!

+
+ ## About The Project @@ -68,3 +119,7 @@ Creating APIs has never been this flexible and straightforward! The CLI For Crea 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!

(back to top)

+ + + +