https://github.com/puskar-roy/create-my-api

An Awesome API Library and a CLI, designed to accelerate the creation of Backend projects.
https://github.com/puskar-roy/create-my-api

api-template cli expressjs gssoc-ext hacktoberfest hacktoberfest-accepted mongodb node-js npm-package postgresql prisma typescript

Last synced: about 17 hours ago
JSON representation

An Awesome API Library and a CLI, designed to accelerate the creation of Backend projects.

• Host: GitHub
• URL: https://github.com/puskar-roy/create-my-api
• Owner: Puskar-Roy
• License: mit
• Created: 2024-03-25T13:50:42.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T18:18:16.000Z (18 days ago)
• Last Synced: 2024-10-29T20:24:47.104Z (18 days ago)
• Topics: api-template, cli, expressjs, gssoc-ext, hacktoberfest, hacktoberfest-accepted, mongodb, node-js, npm-package, postgresql, prisma, typescript
• Language: TypeScript
• Homepage: https://create-my-api.vercel.app
• Size: 2.25 MB
• Stars: 27
• Watchers: 1
• Forks: 26
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

    

  


  
Create My API ✨
 

  


    Welcome to the Create My API CLI your go-to tool and API Library for rapidly setting up production-ready API projects with ease! Whether you're a seasoned developer or just getting started, our API Library and CLI provides a streamlined 

    experience for creating RESTful APIs using various backend technologies and database combinations.

    


    Explore the docs »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



    

        

            🌟 Stars

            🍴 Forks

            🐛 Issues

            🔔 Open PRs

            🔕 Close PRs

        

     

    

         

            

             

            

            

           

        

    



## 🚨 Note 

 - Please Check The [CONTRIBUTING.md](./CONTRIBUTING.md) and Always Push In ```dev``` Branch :)

 - We are Gonna plan to make a **Free API Store** wiht all of the APIs we have, so Feel Free to Contribute in the Next JS Web Part :)

 - Also In Web Part We want to make a Documentetion Part, you can contribute with that :)



## ⚙️ Installation

### Run This Command 🚀

```bash

   npx create-my-api@latest

```

 - ![api](./docs/assets/demo1.png)

### Then Chosse a Configuration, Thats it ⌨️

 - **Express Js, Javascript, Mongo DB**

 - ![api](./docs/assets/demo6.png)

 - **Nest Js, Typescript, Prisma, Postgre SQL**

 - ![api](./docs/assets/demo7.png)

- **Existing E-learning Platform API**

 - ![api](./docs/assets/demo8.png)

 *__Note - You Can Check [Guidebook](./docs/md/Guidebook.md) for more details__*



## 🛠️ Prerequisites

- [Node.js](https://nodejs.org/) installed on your machine 🟩

- [Git](https://git-scm.com/) installed on your machine 🐙



## 📚 API Starter Templates

__*Create My-API*__ offers a variety of starter templates to get your project up and running quickly. Here are some of the available templates:

- `Express-Typescript-with-Mongodb`

- `Express-Javascript-with-Mongodb`

- `Express-Typescript-with-Postgresql`

- `Express-Javascript-with-Postgresql`

- `Nestjs-Typescript-with-Postgresql`



## 📂 Existing APIs

In addition to starter templates, we also provide __Existing APIs__ that you can integrate into your projects:

- `Attendance Portal`

- `E-learning Platform`

- `2FA Auth`

- `Real-time Chat API`



## 🛠️ Tech Stack

__Create My-API supports a variety of technologies and databases:__



### Languages



### Frameworks



### Databases



### Services







## ❤️ Contributing

We welcome contributions to Create My-API! 

To get started, please check out the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on how to contribute. Here are some key points:

- __Create a new branch from your fork for any changes you make.__

- __If you're adding a new API, please add it inside the `packages/APIs` directory.__

- __If you're enhancing existing `templates` or APIs, please work inside the `packages/APIs` or templates directories.__

- __If you're working on the documentation website, please work inside the `apps` directory *(client for Next.js frontend and server for Node.js Express backend).*__

__*Note: If contributions do not follow the guidelines specified in the [CONTRIBUTING.md](./CONTRIBUTING.md) file, the pull request will not be accepted ❌.*__

Contributors of create-my-api 🚀





  







## 📬 Contact

If you have any questions, feel free to open an issue or reach out to the project [maintainer](https://www.linkedin.com/in/puskar-roy/).

__Please ⭐ the repository for show some love!__

### Puskar Roy 🖋️



  back to top