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.
To use Create-KREST, you need to have Node.js installed. You can install and run the package via npm using the following command:
$ npm create krest@latestAlternate way
- To direclty install and use Create-KREST run
$ npx create-krest@latest
krest_hzQAgueS.mp4
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
- 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.
The project structure generated by Create-KREST will include the following directories and files:
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.jsonContributions are welcome! If you find any bugs or have suggestions for new features, please open an issue.
This project is licensed under the MIT License.
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!