Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 2.03 KB

File metadata and controls

101 lines (70 loc) · 2.03 KB

GitHub Setup Instructions

Follow these steps to push your project to GitHub.

Step 1: Create GitHub Repository

  1. Go to https://github.com/new
  2. Repository name: automarket-remote (or your preferred name)
  3. Description: "Remote control for AutoMarket Dalamud plugin"
  4. Make it Private (recommended since it's for game automation)
  5. Do NOT initialize with README, .gitignore, or license (we already have these)
  6. Click "Create repository"

Step 2: Initialize Local Git Repository

# Navigate to your project directory
cd D:\Claude Projects\node\automarket-complete

# Initialize git
git init

# Add all files
git add .

# Make initial commit
git commit -m "Initial commit: Backend API + Web Frontend with PostgreSQL"

Step 3: Connect to GitHub

# Add your GitHub repository as remote (replace YOUR_USERNAME and REPO_NAME)
git remote add origin https://github.com/YOUR_USERNAME/REPO_NAME.git

# Push to GitHub
git branch -M main
git push -u origin main

Step 4: Verify

Go to your GitHub repository URL and you should see all your files!

Future Commits

After making changes:

# Check what changed
git status

# Add changed files
git add .

# Commit with a message
git commit -m "Description of your changes"

# Push to GitHub
git push

Recommended: Add .env to .gitignore

The .gitignore file already excludes .env files to prevent accidentally committing secrets.

IMPORTANT: Never commit:

  • .env files (contains JWT_SECRET and passwords)
  • node_modules/ directories
  • Database files

These are already in .gitignore so you're safe!

Branch Strategy (Optional)

For collaborative development:

# Create a dev branch
git checkout -b dev

# Make changes, commit
git add .
git commit -m "Add feature"

# Push dev branch
git push -u origin dev

# Merge to main when ready
git checkout main
git merge dev
git push

Done! 🎉

Your project is now on GitHub and you can:

  • Track changes over time
  • Collaborate with others
  • Deploy from GitHub
  • Create backups automatically