Skip to content

create-crud-api/create-crud-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-crud-api

create-crud-api is a simple and efficient tool to generate CRUD APIs quickly. With a few prompts, it allows you to choose your preferred framework, ORM, and folder structure.

Getting Started

To use this package, you need to have Node.js installed. If you haven't installed it yet, you can download it from here.

Installation

You don't need to install this package globally. Instead, you can use it with npx:

npx tuttrue-create-crud-api

Usage

Run the command above and follow the prompts:

  1. Choose your framework: Select the framework you want to use (e.g., Express, Hono, etc.).
  2. Choose your ORM: Select the ORM for database interaction (e.g., Prisma, Mongoose, etc.).
  3. Choose your folder structure: Select the folder structure for your project.

The tool will then generate the necessary files and folders for a basic CRUD API setup based on your choices.

Features

  • Framework selection: Choose from popular frameworks to build your API.
  • ORM selection: Integrate your preferred ORM for database operations.
  • Customizable folder structure: Organize your project the way you like.

Contributing

We welcome contributions! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature-branch).
  6. Open a pull request.

What to Contribute

  • New frameworks and ORMs: Help us support more frameworks and ORMs.
  • Bug fixes: Identify and fix bugs.
  • Documentation: Improve and expand the documentation.
  • Feature requests: Suggest and implement new features.
  • Examples: Provide examples and tutorials to help others get started.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

If you have any questions or need further assistance, feel free to open an issue or contact us at [email protected].

About

Set up a basic crud api by running one command.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published