# make-express-api

> 'make-express-api' is a cli tool which help back-end developers to generate express api faster. By writing a single line of code, developer will be able to create CRUD api for a specific module. This tool not only will generate the API, it will take care

Latest version **1.0.5** (published 2024-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install make-express-api
pnpm add make-express-api
yarn add make-express-api
bun add make-express-api
```

Provides the command `create-scaffold`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2024-04-15 |
| First published | 2024-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 16.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | MM Tareque |
| Maintainers | mm_tareque |
| Keywords | scaffold express api, scaffold api, scaffold express, express api generator, make express api, express scaffold, api scaffold |

## Links

- npm: https://www.npmjs.com/package/make-express-api
- Repository: https://github.com/mmTareque01/make-express-api
- Homepage: https://github.com/mmTareque01/make-express-api#readme
- Issues: https://github.com/mmTareque01/make-express-api/issues
- npm.io page: https://npm.io/package/make-express-api

## Dependencies (2)

- [fs-extra](https://npm.io/package/fs-extra.md) ^11.2.0
- [commander](https://npm.io/package/commander.md) ^12.0.0

## Recent versions

- 1.0.5 (latest) — 2024-04-15
- 1.0.4 — 2024-04-13
- 1.0.3 — 2024-04-13
- 1.0.2 — 2024-04-13
- 1.0.1 — 2024-04-13
- 1.0.0 — 2024-04-10

## README

# Make-Express-API

    **********{ make-express-api }**********
"make-express-api" is a cli tool which help back-end developers to generate express api faster. By writing a single line of code, developer will be able to create CRUD api for a specific module. This tool not only will generate the API, it will take care of proper folder structure as well as versioning system.  By default the rest api is designed by following "Rechardson standard level". Right now user won't be able to change it whether they are rewriting the api response.


## Contribute

This is an open source project. Anybody can contribute with this project. If any of you want to contribute with this project to help express developer community, you guys are welcome.

- [Github](https://github.com/mmTareque01/make-express-api)

## Authors
Hi, I am Muhimenul Tareque, who developed the entire system inspired by RoR scaffold system. To know more you can visit the link bellow. Thank you.

- [@Github](https://github.com/mmTareque01)
- [@LinkedIn](https://linkedin.com/in/mmtareque)
- [@whatsapp](https://wa.me/01793899433)
- [@website](https://mmtareque.com)



## How to use
It is very simple to use this application. To use this application just follow the instructions mentioned bellow:

- Download the package within your express project
```shell
npm i make-express-api
```
- Create a config file called ```scaffold.config.js``` at root directory of your project.
- Add this with ```package.json```
```
"scripts": {
  "scaffold": "create-scaffold"
}
```
- Add the following option into the config file.
```
module.exports = {
    language: "js", // value=> js
    folders: {
        route: "routes", // routig folder name
        controller: "controllers", // controller folder name
        service: "repositories" //service folder name
    }

};

```

- If you done the step written above, you are good to make api's using ```make-express-api``` app.
- Open your terminal and run the following command from the root of the project directory. ```npm run scaffold -- -v <version> -m <module_name>```
Example: ```npm run scaffold -- -v v1 -m books```

- Now your API's are ready. It's time to connect the api with main file.
- Open your main file index.js or app.js and import the router from the route file.
- Add ```app.use('books/v1/', booksRouter)```


## Limitations

The application has some limitations, as you are going to use this, you should keep it mind:

- Till now, the application only able to create CRUD for a module.
- You won't abe to create a single api.
- If already exist any module wihtin the same, the existing one will be replaced.


## Next Version
The upcoming Version will solve the current limitations.
Like:
- Developer will be able to create a single api's;
- Developer will be able to generate custom structure;

---
_Source: https://npm.io/package/make-express-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
