Socket
Socket
Sign inDemoInstall

branch-tea

Package Overview
Dependencies
13
Maintainers
0
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

branch-tea

branch tea cli for quick express app setup


Version published
Maintainers
0
Created

Readme

Source

Branch Tea Cli

Branch Tea Cli is client base cli for developers that make the setting up of a new express app a breeze.

This cli comes with some additional features

  • Creating file structure
  • Configurations
  • Package installation
  • Extra package called branch-tea-utils

Notes

[!NOTE] Using this cli does not mean you must work with the file structure or use the branch-tea-utils package bundled with it But if you do find the cli and branch-tea-utils interesting use it as you please.

[!NOTE] Also contribution and bug reports is welcome.

Installation

npm install -g branch-tea

or

yarn global add branch-tea

Commands and Options

Creates folder and file structure for an Express app.

Options -p, --package-manager : Specify the package manager (npm or yarn). Default is npm. -d, --dir : Specify the directory name. -c, --config', 'Output configuration data to add to .env'

Output configuration

branch-tea -c

Create app examples Create Express app with default folder structure

branch-tea create -optional[-p] [yarn/npm] -optional[-d] app-name-directory 

Using shorcut Create Express app with default folder structure

bt create -optional[-p] [yarn/npm] -optional[-d] app-name

Start Sever

yarn start

or

npm run start

To connect to db using the package settings

uncomment the following line in index.ts file.

// add this import
import { InitializeDBType } from 'branch-tea-utils';

// if (useDB){
//     const databaseConnection: InitializeDBType = await database.initializeDB(databaseTypes);
//     // Check if the database is connected before starting the server
//     console.log(databaseConnection.message);
//     if (!databaseConnection.status) throw new Error(databaseConnection.message);
// }

ENV configuration

config files
#database configures 
MAX_URL_ENCODINGS="5MB"
PORT=3000
DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASS=
DB_NAME=ktr_db
#if set the synchronization on the db connection settings be set to true 
SYNC=true

# production or development
NODE_PRODUCTION=false

#smtp configuration
SMTP_HOST=smtp_host
SMTP_PORT=465
SMTP_USER=smtp_user
SMTP_PASSWORD=smtp_password
SMTP_FROM=smtp_email

#sercret keys
JWT_SECRET_KEY=verystrongkey
REFRESH_JWT_SECRET_KEY=verystrongkey

MAX_FILE_UPLOAD=5

Keywords

FAQs

Last updated on 09 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc