Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/krsbx/create-roses-backend

Simplify process of creating a TypeSafety backend with Node Js, Prisma, and TypeScript
https://github.com/krsbx/create-roses-backend

epxress nodejs prisma prisma-client repository-pattern typescript

Last synced: 21 days ago
JSON representation

Simplify process of creating a TypeSafety backend with Node Js, Prisma, and TypeScript

Awesome Lists containing this project

README

        


create-roses-backend


Interactive CLI to quickly set up a RESTful backend API with Express, Prisma, and TypeScript.


Get started with CRB by running npx create-roses-backend

[![PRs-Welcome][contribute-image]][contribute-url] [![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]

[downloads-image]: https://img.shields.io/npm/dm/create-roses-backend?color=364fc7&logoColor=364fc7
[npm-url]: https://www.npmjs.com/package/create-roses-backend
[npm-image]: https://img.shields.io/npm/v/create-roses-backend?color=0b7285&logoColor=0b7285
[contribute-url]: https://github.com/krsbx/create-roses-backend/blob/main/CONTRIBUTING.md
[contribute-image]: https://img.shields.io/badge/PRs-welcome-blue.svg

## Table of contents

- What is CRB?
- Getting Started
- CLI Docs
- Contributors

What is CRB?

"_Create Roses Backend_" is a CLI that you can run to initialize your Backend much faster by including all the necessary tools that you need, including 2 API template that you can chose to use.

**Keep in mind** that the generated template/boilerplate can still be modified as much as you like. The API template that we provide are a simple API that we believe can help you to initialize your code faster since it's one of the API that most people need.

Getting Started

To get started with `create-roses-backend`, run any of the following commands and answer any questions from the prompt:

### npm

```bash
npx create-roses-backend@latest
```

CLI Docs

The following CLI options and flags can be use to configure the behavior when running the CLI:

| Option/Flag | Description |
| ----------------- | ----------------------------------------------------- |
| `[dir]` | The directory to create the new Roses Backend |
| `--noGit` | Explicitly tell to not init a git repository |
| `--noInstall` | Explicitly tell to not install all dependencies |
| `--withTemplate` | Explicitly tell to use all templates |
| `--withUser` | Explicitly tell to use user templates |
| `--withFile` | Explicitly tell to use file templates |
| `-y`, `--default` | Bypass the CLI and use default values for all prompts |

Contributors

We 💖 contributors! Feel free to contribute to this project but **please read the [Contributing Guidelines](CONTRIBUTING.md) before opening an issue or PR** so you understand the branching strategy and local development environment.