Personal git template / starter

with Github Actions and config setup (package manager, bundler...)

🛠 Setup

🛑 Must install Bun first, using this command: curl -fsSL https://bun.sh/install | bash

✨ 1. Commits

• To have auto-prepended emojis in your commits, run the following:
  (ex: fix ajax stuff becomes 🐛 Fix: ajax stuff automatically)

bunx husky install

🤖 2. Github (readme, actions...)

• Edit deployment files paths located in:

  • .github/workflows/deploy-preprod.yml
  • .github/workflows/deploy-prod.yml

• Set repository secrets below in repository settings:

  PREPROD_FTP_HOST
  PREPROD_FTP_USER
  PREPROD_FTP_PASS
  
  PROD_FTP_HOST
  PROD_FTP_USER
  PROD_FTP_PASS

📖 3. Readme template

Looks something like:

• Copy code below into .github/README.md and change repository paths!

# Project

### Status
![deploy-preprod](https://github.com/DamChtlv/git-template/actions/workflows/deploy-preprod.yml/badge.svg?branch=release/preprod)
![deploy-prod](https://github.com/DamChtlv/git-template/actions/workflows/deploy-prod.yml/badge.svg?branch=release/prod)

❔ How to use

Package manager / bundler / test runner used in this repo is bun

1. Install scripts

bun i

2. Run scripts (from package.json)

bun run script-name

3. Execute package

bunx module-name

4. Build assets

bun build ./index.js --outdir ./build

5. Spin up a static server on localhost:5000

bunx serve folder-name

6. Run tests

bun test

---

💡 Improvments / ideas

• Force lint commits messages using commitlint?
• Automatically generate a changelog based on commits using Git Cliff?