https://github.com/sunilksamanta/calmapi
Production ready Modular REST API Generator using NodeJS & MongoDB
https://github.com/sunilksamanta/calmapi
generator hacktoberfest hacktoberfest2023 mongodb mongoose nodejs rest-api
Last synced: 12 months ago
JSON representation
Production ready Modular REST API Generator using NodeJS & MongoDB
- Host: GitHub
- URL: https://github.com/sunilksamanta/calmapi
- Owner: sunilksamanta
- License: mit
- Created: 2021-03-29T03:15:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T06:21:37.000Z (about 2 years ago)
- Last Synced: 2024-04-24T22:19:58.855Z (almost 2 years ago)
- Topics: generator, hacktoberfest, hacktoberfest2023, mongodb, mongoose, nodejs, rest-api
- Language: JavaScript
- Homepage: https://calmapi.dev
- Size: 626 KB
- Stars: 22
- Watchers: 3
- Forks: 10
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Calm API
### Production ready Modular REST API generator using NodeJS & MongoDB
[](https://badge.fury.io/js/calmapi)
[](https://deepscan.io/dashboard#view=project&tid=12352&pid=18169&bid=439384)
### INSTALLATION
Install by running
```shell
npm i -g calmapi
```
Then run inside your workspace directory
```shell
calmapi
```
And follow the easy steps.
### MODULE GENERATION
Generate CalmAPI CRUD Module just by running the following inside project's root.
```shell
calmapi generate module product
```
Valid Module generation commands.
```shell
calmapi generate module product
```
```shell
calmapi generate module products
```
```shell
calmapi generate module productMeta
```
```shell
calmapi generate module ProductMeta
```
```shell
calmapi generate module product-meta
```
Generate Module name without pluralize
```shell
calmapi generate module test-series --force
```
### FEATURES
* Production ready - Controller, Model & Service oriented architecture
* Modules with automated Routing (Nested Route support)
* Built-in Authentication Module with JWT & DB Store authentication
* Built-in User Module
* Built-in Media Module for file upload [AWS S3 Support]
* Build-in CRUD operations for modules with pagination, filters, sorters
* Sample Post Module (CRUD Operation Example)
* **CRUD Module generation command line support.**
* No Hidden sh*ts in your node_modules. Completely free to customize
* Prebuilt CRUD operation classes for Controller & Service
* DTO Support( Data transfer Object)
* Eslint rules enabled
* .env support
* And many more
### Contributors
* [Sunil Kr. Samanta](https://github.com/sunilksamanta)
* [Rajdip Mondal](https://github.com/RajdipM)
*We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: Reporting a bug, Documentation, Discussing the current state of the code, Submitting a fix or Proposing new features.*
### Credits
[Thiago Pacheco](https://github.com/pachecoio) for the idea of better NodeJS architechture.