backend-builders / backend-builder Goto Github PK

View Code? Open in Web Editor NEW

3.0 2.0 1.0 114 KB

CLI tool to generate backend boilerplates.

License: MIT License

TypeScript 5.13% JavaScript 84.81% Python 10.06%

backend cli tool boilerplates

backend-builder's Introduction

Backend Builder

Welcome!

Backend Builder is a user-friendly CLI tool in Node.js that generates backend application boilerplates. Perfect for developers entering the career and preparing for technical interviews, it simplifies project setup with a simple and intuitive interface. Say goodbye to time-consuming setup tasks and hello to efficient development.

Key Features

Community driven open source project.
Intuitive and straightforward CLI interactions.
Quick and easy installation process.
Generates standardized boilerplates for backend applications.
Provides a solid foundation for your projects, enabling you to focus on your unique functionalities.
Built with Node.js to leverage its powerful ecosystem and ensure cross-platform compatibility.

Current Boilerplates

Node/Express Server
Node/Express Server built with TypeScript

More coming soon...

Run Locally

Clone the project:

  git clone https://github.com/Backend-Builders/backend-builder.git

Go to the project directory:

  cd backend-builder

Install dependencies:

  npm install

Start the application:

  npm run start

Running Tests

To run tests, run the following command:

  npm run test

License

MIT

Authors

Backend-Buiders

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's Code of Conduct.

Translations of these documents can be found here.

Support

For support, join our Discord channel.

backend-builder's People

Contributors

Stargazers

Watchers

Forkers

limapaulobsb

backend-builder's Issues

Automatically change new project name

Expected Behavior

The project name in package.json must be the same as the one chosen by the user.

Current Behavior

New projects have the same name as the boilerplate.

Create license options for new projects

Expected Behavior

When creating a new project, the user will be able to choose the type of license through options in the CLI.

Current Behavior

No license files in boilerplates.

Possible Solution

Create a prompt with license options, copy the appropriate file and change the package.json

Create CI configuration

Expected Behavior

The project should have files and settings for CI (Continuous Integration).

Current Behavior

No CI configuration.

Automatically install boilerplate dependencies (npm install)

Expected Behavior

Dependencies should be installed automatically after transferring boilerplate directories and files.

Current Behavior

Installation is done manually with the command npm install

Possible Solution

Use the child_process module
https://stackabuse.com/executing-shell-commands-with-node-js/

Edit new project details

Expected Behavior

The user should be given the option to provide details about the project, which will change in the package.json file (eg description, tags, etc)

Current Behavior

The option is unavailable.

Add instruction messages at the end of the process

Expected Behavior

The final output could have short instructions on how to access and run the project.

Current Behavior

Current output is just 'Project [project name] successfully created!'.

Create a Python/Flask boilerplate and make adjustments as needed

Expected Behavior

We need boilerplates in other languages and technologies and adapt the main code as needed.

Current Behavior

Only Node.js boilerplates and core functions adapted just for this environment.

Add validation to prompts

Expected Behavior

CLI prompts must have proper validation to verify that user input is valid (no blank, minimum characters, etc).

Current Behavior

No validation.

Possible Solution

Use the Inquirer validation property as exemplified here: https://github.com/SBoudrias/Inquirer.js/tree/master/packages/input

Create the Contribution Guidelines and Code of Conduct

Expected Behavior

Open source projects must have the Contribution Guidelines and Code of Conduct documents.

Current Behavior

Without documentation.

Complete the README files

Expected Behavior

A proper README file must exist in the main project and in the boilerplates.

Current Behavior

No README files.

Check if the project folder already exists

Expected Behavior

There should be a check if the directory with the project name already exists in the user's cwd

Current Behavior

No verification.

Start test development for the main project

Expected Behavior

The main structure of the project should have tests covering user interactions with the CLI and other core functionality as performed by the file system module.

Current Behavior

No tests.

Sources:
https://github.com/SBoudrias/Inquirer.js/tree/master/packages/testing

Create a GitHub Action workflow for tests on PRs

Expected Behavior

There should be an automated workflow for running tests on Pull Requests.

Current Behavior

No automation.

Possible Solution

Create a file similar to the ESLint workflow.

Create the first tests for Node/Express boilerplates

Expected Behavior

Node/Express boilerplates (with and without TypeScript) must have their first functionality tests.

Current Behavior

No tests.

Create a loading effect for the installation

Expected Behavior

There should be an animation or other indication of processing during project installation.

Current Behavior

No loading or any feedback about the process.

Create modules to separate functionalities

Expected Behavior

Each functionality should be in separate modules for better readability and code maintenance.

Current Behavior

All code is in one file (index.js)

backend-builders / backend-builder Goto Github PK

backend-builder's Introduction

Backend Builder

Key Features

Current Boilerplates

Run Locally

Running Tests

License

Authors

Contributing

Support

backend-builder's People

Contributors

Stargazers

Watchers

Forkers

backend-builder's Issues

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Possible Solution

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Possible Solution

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Possible Solution

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Possible Solution

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Expected Behavior

Current Behavior

Recommend Projects

Recommend Topics

Recommend Org