What files and folders to include in .gitignore in Shopify App Development?

What files and folders to include in .gitignore in Shopify App Development?

raul-vila
Shopify Partner
5 1 1

Hi there,

 

I would like to know what should the .gitignore include when developing a public App for the Shopify App Store.

This is what I currently have:

# Environment Configuration
.env

# Dependency directory
node_modules

# Test coverage directory
coverage

# Ignore Apple macOS Desktop Services Store
.DS_Store

# Logs
logs
*.log

# ngrok tunnel file
config/tunnel.pid

# vite build output
dist/

# extensions build output
extensions/*/build

# Node library SQLite database
web/database.sqlite

# Partners can use npm, yarn or pnpm with the CLI.
# We ignore lock files so they don't get a package manager mis-match
# Without this, they may get a warning if using a different package manager to us
yarn.lock
package-lock.json

I'm struggling with the .toml files, given that if there are more users working on the same app, and they decide to config the app differently, things will change in the shopify.app.toml file.

I'm assuming I should add it to the .gitignore, but as it's not there by default, i want to understand what are the best practices.

Replies 0 (0)