Skip to content

Instantly share code, notes, and snippets.

@imroca
Last active April 20, 2024 15:08
Show Gist options
  • Save imroca/80f21168c291e934776598c9fee9a087 to your computer and use it in GitHub Desktop.
Save imroca/80f21168c291e934776598c9fee9a087 to your computer and use it in GitHub Desktop.
Setup a Node Project Guide
PROJECT_NAME="" # my-app
MAIN="" # index.mjs
# npm config set init-author-name "Your name"
# npm config set init-author-email "Your email"
# npm config set init-license "MIT"
# npm config set init-version "0.1.0"
mkdir $PROJECT_NAME
cd $PROJECT_NAME
git init
npm init -y
npm pkg set description="Your project description"
npm pkg set type="module"
npm pkg set main="$(MAIN)"
npx --yes license $(npm get init-license) -o "$(npm get init-author-name)" > LICENSE
npx --yes gitignore node
npx covgen "$(npm get init-author-email)"
cat > README.md <<- README
# Welcome to $(npm pkg get name | tr -d '"')
##Overview
$(npm pkg get description | tr -d '"')
##Author(s)
👤 **$(npm get init-author-name) <$(npm get init-author-email)>**
##Installation
README
cat > CONTRIBUTING.md <<- CONTRIB
# Contributing to CONTRIBUTING.md
First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
CONTRIB
touch $MAIN
git add -A
git commit -m "Initial commit"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment