Contributing Guide

git clone https://github.com/YOUR_USERNAME/TerraQuakeApi.git
cd TerraQuakeApi

git remote add upstream https://github.com/nagcas/TerraQuakeApi.git

# Navigate to backend directory
cd backend

# Install dependencies
npm install

# Copy environment variables
cp .env-example .env

# Edit .env with your configuration
# Add database URL, API keys, etc.

# Start development server
npm run dev

# Navigate to frontend directory (in a new terminal)
cd frontend

# Install dependencies
npm install

# Copy environment variables if needed
cp .env-example .env

# Start development server
npm run dev

git checkout -b feature/your-feature-name
# or
git checkout -b fix/issue-description

# Run tests
npm run tests

# Run linter
npm run lint

# Fix linting issues automatically
npm run lint:fix

git add .
git commit -m "feat: add new feature description"
# or
git commit -m "fix: resolve issue description"

git push origin feature/your-feature-name

## Description
Brief description of what this PR does

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring

## Testing
- [ ] All existing tests pass
- [ ] Added new tests for new features
- [ ] Manually tested changes

## Checklist
- [ ] Code follows project style guidelines
- [ ] Self-reviewed my code
- [ ] Commented complex code sections
- [ ] Updated documentation
- [ ] No breaking changes (or documented if necessary)

// Good
const fetchEarthquakes = async (params) => {
  try {
    const response = await axios.get(url, { params })
    return response.data
  } catch (error) {
    console.error('Error fetching earthquakes:', error.message)
    throw error
  }
}

// Use descriptive variable names
// Add comments for complex logic
// Handle errors appropriately
// Follow async/await patterns

# Run all tests with coverage
npm run tests

# Run linter
npm run lint

// Example test structure
import { test } from 'node:test'
import assert from 'node:assert'

test('fetchEarthquakes returns valid data', async (t) => {
  const result = await fetchEarthquakes({ limit: 10 })
  
  assert.ok(result.success)
  assert.strictEqual(result.code, 200)
  assert.ok(Array.isArray(result.payload))
})

TerraQuakeApi/
├── backend/               # Node.js + Express API
│   ├── src/
│   │   ├── controllers/   # Request handlers
│   │   ├── routes/        # API routes
│   │   ├── services/      # Business logic
│   │   ├── utils/         # Helper functions
│   │   └── app.js         # Application entry point
│   ├── package.json
│   └── .env-example
├── frontend/              # React + Vite interface
│   ├── src/
│   │   ├── components/    # React components
│   │   ├── pages/         # Page components
│   │   └── App.jsx        # Application root
│   ├── package.json
│   └── .env-example
├── README.md
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
└── LICENSE.md