1.0.3 • Published 3 years ago

create-me-app v1.0.3

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

Create Express App

NPM

Installation

Yarn

yarn global add create-me-app

NPM

npm install create-me-app -g

Usage

create-me-app <project-name> <template> [-c | --code] [-p | --prettier]  [-g | --git] [-i | --install] [--help]

//example
create-me-app rare-app typescript

npm >= 6.1

npm init me-app

or with yarn

yarn create me-app

Parameters

<project-name> : name of the project to create

<template> : typescript or javascript

Options

--yes or -y : skip all prompts

--git or -g : initialize git repository

--install or -i : install dependencies

--prettier or -p : format project documets with prettier

--code or -c : open project with VS Code

The architecture of the project will look like below

rare-app/
├── src
│   ├── config
│   │    ├── config.ts
│   │    └── logger.ts
│   ├── controllers
│   │    ├── error.ts
│   │    └── sample.ts
│   ├── core
│   │    └── db.ts
│   ├── models
│   │    └── Sample.ts
│   ├── routes
│   │    ├── index.ts
│   │    └── sample.ts
│   ├── storage
│   │    ├── mongo
│   │    │   └── sample.ts
│   │    ├── repo
│   │    │   └── sample.ts
│   │    └── main.ts
│   ├── utils
│   │    ├── appError.ts
│   │    └── catchAsync.ts
│   ├── validators
│   │    └── sample.ts
│   ├── test
│   ├── types
│   ├── app.ts
│   └── index.css
├── .env
├── .gitignore
├── .prettierrc
├── tsconfig.json
├── package.json
└── README.md

Run project

npm start

Run the app in development mode. Open http://localhost:3000/status to check the status.