https://github.com/timolinn/create-node-app
Create a new NodeJS express app using an existing node starter kit
https://github.com/timolinn/create-node-app
kit node-starter-kit nodejs
Last synced: about 1 month ago
JSON representation
Create a new NodeJS express app using an existing node starter kit
- Host: GitHub
- URL: https://github.com/timolinn/create-node-app
- Owner: timolinn
- License: mit
- Created: 2019-04-28T13:25:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-01T11:47:49.000Z (almost 6 years ago)
- Last Synced: 2025-02-05T14:50:10.093Z (3 months ago)
- Topics: kit, node-starter-kit, nodejs
- Language: Shell
- Homepage:
- Size: 3.91 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create Node App 😄
This is a simple bash script for creating an express app using [node-starter](https://github.com/timolinn/node-starter) kit (it is fully customizable).
This script was wriiten mostly for personal use, but feel free to make it your own 🙂!
## Installation
+ Clone this repo
```bash
git clone https://github.com/timolinn/create-node-app
```
+ Then run `cd create-node-app`
Make the script executable on bash:
```bash
chmod u+x create-node-app
```
The script is ready to use!!! 😁.
## Usage
Go ahead and run any of the commands below
```bash
./create-node-app
// OR
./create-node-app newapp
// OR
./create-node-app -s https://github.com/example/another-node-kit
// For the rest
./create-node-app -h
```
## Make `create-node-app` command accessible from anywhere on your system
First create a `bin` in your home directory:
```bash
mkdir ~/bin
```
Copy the script to the bin folder
```bash
cp ./create-node-app ~/bin
```
Execute the following command:
```
// Add this to `.bash_profile` to persist to persist it. Then open a new shell.
export PATH=$PATH:$HOME/bin
```
That's it! Now you can run `create-node-app` from anywhere.
# Uninstall
Simple run `rm ~/bin/create-node-app`
## Warning
**Doesn't work well if source URL is incorrect**. see TODO
## TODO
- [ ] Add error handling for invalid git url
- [ ] Add support for private repository