Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kunal00000/create-krest
A CLI tool to create APIs in multiple languages with multiple integrations in just seconds.
https://github.com/kunal00000/create-krest
api backend-api cli express typescript
Last synced: 2 days ago
JSON representation
A CLI tool to create APIs in multiple languages with multiple integrations in just seconds.
- Host: GitHub
- URL: https://github.com/kunal00000/create-krest
- Owner: kunal00000
- License: mit
- Created: 2023-07-22T01:25:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-02T20:27:35.000Z (about 1 year ago)
- Last Synced: 2024-10-11T22:47:27.272Z (about 1 month ago)
- Topics: api, backend-api, cli, express, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/create-krest
- Size: 56.6 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create-KREST (Create Simple APIs in seconds)
Create-KREST is a command-line tool that helps you quickly scaffold a simple REST API project. Whether you're starting a new project or prototyping an idea, Create-KREST provides you with the essentials to kickstart your development process.
### Installation & Usage
To use Create-KREST, you need to have Node.js installed. You can install and run the package via npm using the following command:
```bash
$ npm create krest@latest
```
**_Alternate way_**
- To direclty install and use Create-KREST run
```
$ npx create-krest@latest
```
### Quick tutorial
https://github.com/kunal00000/create-krest/assets/92316166/2b3319c0-bdec-4115-afc3-bbb7d463b003
### Questions
During the setup process, Create-KREST will ask you a series of questions to configure your API project:
**Select a language:**
- Javascript
- Typescript
**Select a variant to create API:**
- Basic CRUD
- CRUD + JWT Auth
- CRUD + MongoDB Database
- CRUD + MongoDB Database + JWT Auth
### Current Features
- Sample API endpoints to jumpstart your development.
- Easily integrate JWT (JSON Web Token) authentication middleware for secure API access.
- MongoDB integration for easy database connectivity.
- Customizable templates for different features to suit your project's needs.
### Project Structure
The project structure generated by Create-KREST will include the following directories and files:
```bash
server/
├── controllers/
│ └── todo.controllers.js
│
├── db/
│ └── index.js
│
├── middlewares/
│ └── auth.middlewares.js
│
├── models/
│ └── user.models.js
│
├── routes/
│ └── todo.routes.js
│
├── config.js # Configuration file
├── index.js
├── .env # Set environment variables(if any)
├── .gitignore
└── package.json
```
## Contributing
Contributions are welcome! If you find any bugs or have suggestions for new features, please open an issue.
### License
This project is licensed under the MIT License.
### Acknowledgments
Create-KREST is inspired by the need for a simple and efficient way to start building REST APIs. Special thanks to the developers of "commander" and "inquirer" for their excellent packages.
**_Thank you for using Create-KREST! If you encounter any issues or have any questions, please don't hesitate to reach out. Happy coding!_**