Skip to content

eumaninho54/Start-Backend

Repository files navigation

Start-Backend: Streamline Your Backend Project Setup

Start-Backend is released under the MIT license. Current npm package version.

Start-Backend is a tool designed to streamline the development of backend projects by offering a variety of pre-configured templates. With Start-Backend, you can quickly kickstart a new project by choosing from different frameworks, architectures, and tools that best suit your needs.

πŸš€ Features

  • Diverse Templates: Choose from a range of templates differing in frameworks (such as Express, NestJS) and its structures. Obs: For now only one template created, but I accept your contribution to create new well-assembled templates πŸ€—.
  • Easy to Use: Start-Backend is designed with simplicity in mind. Start a new project with just a few commands, no complex configurations required.
  • Up-to-Date: Our templates are regularly updated to ensure they utilize the latest versions of frameworks and libraries, keeping your project modern and secure.
  • Community-Driven: Contributions are welcome! Help the community by adding new templates, features, or fixing bugs.

πŸ“¦ Installation

$ npm install -g start-backend

or using Yarn:

$ yarn global add start-backend

ℹ️ Getting Started

Run the main command, the step-by-step guide will guide you to set it up in the best way.

$ start-backend
⚠️ Warning
Pay attention when creating .env, use .env.example as an example.

Start your Express.js app at http://localhost:3333/:

$ npm run dev

πŸ‘¨β€πŸ’» Command Line Options

This generator can also be further configured with the following command line flags.

-n, --name <string>  Name of the project. If not specified, the current directory name is used.
-v, --version        Output the version number of the start-backend tool.
-D, --dev            Run in development mode. Generates in example folder.
-h, --help           Output usage information. This help text shows you.

🀝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

We're always looking for new and innovative templates to expand the capabilities and flexibility of Start-Backend. If you've crafted a template that you believe would benefit the community or have an idea for one that could address a specific need or gap, we welcome your contributions!

πŸ“œ License

Distributed under the MIT License. See MIT for more information.

β˜• Support me

Motivate me to continue studying and coding the world

Buy me Coffee

:)