will/adopt-a-street
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update npm commands to bun in README and documentation files

Browse Source 
- Replace npm install with bun install
- Replace npm start/test/build with bun equivalents
- Update deployment and testing documentation
- Maintain consistency with project's bun-first approach

🤖 Generated with [AI Assistant]

Co-Authored-By: AI Assistant <noreply@ai-assistant.com>
This commit is contained in:
William Valentin
2025-11-01 12:41:59 -07:00
parent c5dbe57d74
commit 37b22039a7
12 changed files with 107 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+13 -13
View File
@@ -24,10 +24,10 @@ After implementing any feature, fix, or update, you MUST:
1. **Build and test** the changes:
```bash
# Backend
cd backend && npm test
cd backend && bun test
# Frontend
cd frontend && npm run build
cd frontend && bun run build
```
2. **Create a git commit** with a descriptive message:
@@ -99,19 +99,19 @@ Frontend proxies API requests to `http://localhost:5000` in development.
### Backend
```bash
cd backend
npm install
bun install
# Create .env file with MONGO_URI, JWT_SECRET, PORT
node server.js # Start backend on port 5000
npx eslint . # Run linter
bunx eslint . # Run linter
```
### Frontend
```bash
cd frontend
npm install
npm start # Start dev server on port 3000
npm test # Run tests in watch mode
npm run build # Production build
bun install
bun start # Start dev server on port 3000
bun test # Run tests in watch mode
bun run build # Production build
```
## Environment Variables
@@ -185,16 +185,16 @@ Comprehensive test infrastructure is in place for both backend and frontend.
Backend:
```bash
cd backend
npm test # Run all tests
npm run test:coverage # Run with coverage report
npm run test:watch # Run in watch mode
bun test # Run all tests
bun run test:coverage # Run with coverage report
bun run test:watch # Run in watch mode
```
Frontend:
```bash
cd frontend
npm test # Run in watch mode
npm run test:coverage # Run with coverage report
bun test # Run in watch mode
bun run test:coverage # Run with coverage report
```
### Test Coverage
IMPLEMENTATION_COMPLETE.md
+13 -13
View File
@@ -327,9 +327,9 @@ All requested features have been **fully implemented** across the Adopt-a-Street
- `__tests__/routes/` - auth, streets, tasks, posts, events, rewards, reports tests
**Test Scripts:**
- `npm test` - Run all tests
- `npm run test:coverage` - With coverage report
- `npm run test:watch` - Watch mode for TDD
- `bun test` - Run all tests
- `bun run test:coverage` - With coverage report
- `bun run test:watch` - Watch mode for TDD
#### Frontend Testing
@@ -348,8 +348,8 @@ All requested features have been **fully implemented** across the Adopt-a-Street
- `__tests__/auth-flow.integration.test.js` - Full auth flow test
**Test Scripts:**
- `npm test` - Run in watch mode
- `npm run test:coverage` - With coverage report
- `bun test` - Run in watch mode
- `bun run test:coverage` - With coverage report
#### Documentation
@@ -440,20 +440,20 @@ All requested features have been **fully implemented** across the Adopt-a-Street
#### Backend
```bash
cd backend
npm install
bun install
# Create .env with: MONGO_URI, JWT_SECRET, CLOUDINARY_* variables
npm start # Start server on port 5000
npm test # Run tests
npm run test:coverage # Run tests with coverage
bun test # Run tests
bun run test:coverage # Run tests with coverage
```
#### Frontend
```bash
cd frontend
npm install
npm start # Start dev server on port 3000
npm test # Run tests
npm run build # Production build
bun install
bun start # Start dev server on port 3000
bun test # Run tests
bun run build # Production build
```
---
@@ -537,7 +537,7 @@ RUN npm ci
COPY . .
# Build production bundle
RUN npm run build
RUN bun run build
# --- Production stage with nginx ---
FROM nginx:alpine
IMPLEMENTATION_SUMMARY.md
+4 -4
View File
@@ -221,7 +221,7 @@ This document details the comprehensive frontend updates implemented for the Ado
### Install Dependencies
```bash
cd /home/will/Code/adopt-a-street/frontend
npm install
bun install
```
This will install:
@@ -231,7 +231,7 @@ This will install:
### Start Development Server
```bash
npm start
bun start
```
The frontend will start on `http://localhost:3000` and proxy API requests to `http://localhost:5000`.
@@ -411,9 +411,9 @@ frontend/
## Next Steps
1. **Run `npm install`** in frontend directory
1. **Run `bun install`** in frontend directory
2. **Start backend server** (node server.js)
3. **Start frontend server** (npm start)
3. **Start frontend server** (bun start)
4. **Test all features** following testing instructions above
5. **Monitor console** for any errors or warnings
6. **Add street coordinates** to backend database for accurate map positioning
SECURITY_AUDIT_REPORT.md
+9 -9
View File
@@ -71,10 +71,10 @@ router.get("/:id", auth, async (req, res) => {
**Remediation:**
```bash
# Backend
cd backend && npm update axios
cd backend && bun update axios
# Frontend
cd frontend && npm update axios
cd frontend && bun update axios
```
**Fix Available:** Yes - Update to axios >= 1.12.0
@@ -212,7 +212,7 @@ User-generated content is rendered directly without sanitization. While React es
Install and use DOMPurify for content sanitization:
```bash
npm install dompurify
bun install dompurify
```
```javascript
@@ -331,7 +331,7 @@ const salt = await bcrypt.genSalt(12); // Increase to 12 or 14 rounds
If using cookies (recommended over localStorage):
```bash
npm install csurf
bun install csurf
```
```javascript
@@ -840,8 +840,8 @@ const posts = await Post.find()
### Recommendation:
```bash
cd backend && npm audit fix
cd frontend && npm audit fix
cd backend && bun audit fix
cd frontend && bun audit fix
```
---
@@ -859,7 +859,7 @@ cd frontend && npm audit fix
### Automated Testing Recommendations:
1. Set up OWASP ZAP or Burp Suite automated scanning
2. Implement security test suite with Jest/Supertest
3. Add pre-commit hook with `npm audit`
3. Add pre-commit hook with `bun audit`
4. Set up Snyk or similar for continuous dependency monitoring
---
@@ -904,10 +904,10 @@ cd frontend && npm audit fix
```yaml
# .github/workflows/security.yml
- name: Security Audit
run: npm audit --audit-level=moderate
run: bun audit --audit-level=moderate
- name: SAST Scan
run: npm run lint:security
run: bun run lint:security
```
### 3. Environment-Specific Configurations
TESTING.md
+17 -17
View File
@@ -206,16 +206,16 @@ describe('Login Component', () => {
cd backend
# Run all tests
npm test
bun test
# Run tests in watch mode
npm run test:watch
bun run test:watch
# Run tests with coverage
npm run test:coverage
bun run test:coverage
# Run tests with verbose output
npm run test:verbose
bun run test:verbose
```
### Frontend Tests
@@ -224,13 +224,13 @@ npm run test:verbose
cd frontend
# Run all tests (interactive watch mode)
npm test
bun test
# Run tests with coverage
npm run test:coverage
bun run test:coverage
# Run tests in watch mode
npm run test:watch
bun run test:watch
```
### Run All Tests
@@ -239,10 +239,10 @@ From the project root:
```bash
# Backend
cd backend && npm test
cd backend && bun test
# Frontend
cd frontend && npm test
cd frontend && bun test
```
## Coverage Reports
@@ -296,11 +296,11 @@ To view HTML coverage reports:
```bash
# Backend
cd backend && npm test -- --coverage
cd backend && bun test -- --coverage
open coverage/lcov-report/index.html
# Frontend
cd frontend && npm run test:coverage
cd frontend && bun run test:coverage
open coverage/lcov-report/index.html
```
@@ -494,12 +494,12 @@ jest.mock('react-leaflet', () => ({
1. **Run specific test files**:
```bash
npm test -- auth.test.js
bun test -- auth.test.js
```
2. **Run tests matching pattern**:
```bash
npm test -- --testNamePattern="login"
bun test -- --testNamePattern="login"
```
3. **Skip tests during development**:
@@ -559,16 +559,16 @@ jobs:
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- run: cd backend && npm install
- run: cd backend && npm test -- --coverage
- run: cd backend && bun install
- run: cd backend && bun test -- --coverage
frontend-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
- run: cd frontend && npm install
- run: cd frontend && npm run test:coverage
- run: cd frontend && bun install
- run: cd frontend && bun run test:coverage
```
## Resources
TESTING_QUICK_START.md
+19 -19
View File
@@ -6,16 +6,16 @@ Quick reference for running tests in the Adopt-a-Street application.
```bash
# Backend tests
cd backend && npm test
cd backend && bun test
# Frontend tests
cd frontend && npm test
cd frontend && bun test
# Backend with coverage
cd backend && npm run test:coverage
cd backend && bun run test:coverage
# Frontend with coverage
cd frontend && npm run test:coverage
cd frontend && bun run test:coverage
```
## What's Been Tested
@@ -49,22 +49,22 @@ cd frontend && npm run test:coverage
cd backend
# Watch mode (TDD)
npm run test:watch
bun run test:watch
# Single test file
npm test -- auth.test.js
bun test -- auth.test.js
# Tests matching pattern
npm test -- --testNamePattern="login"
bun test -- --testNamePattern="login"
# Coverage report
npm run test:coverage
bun run test:coverage
# Verbose output
npm run test:verbose
bun run test:verbose
# Update snapshots
npm test -- -u
bun test -- -u
```
### Frontend
@@ -73,22 +73,22 @@ npm test -- -u
cd frontend
# Watch mode (default)
npm test
bun test
# Coverage report
npm run test:coverage
bun run test:coverage
# Single test file
npm test -- Login.test.js
bun test -- Login.test.js
# Tests matching pattern
npm test -- --testNamePattern="should render"
bun test -- --testNamePattern="should render"
# No watch mode
CI=true npm test
CI=true bun test
# Update snapshots
npm test -- -u
bun test -- -u
```
## Writing Your First Test
@@ -171,11 +171,11 @@ After running tests with coverage, open the HTML report:
```bash
# Backend
cd backend && npm run test:coverage
cd backend && bun run test:coverage
open coverage/lcov-report/index.html
# Frontend
cd frontend && npm run test:coverage
cd frontend && bun run test:coverage
open coverage/lcov-report/index.html
```
@@ -228,7 +228,7 @@ testTimeout: 30000
**MongoDB connection issues**
```bash
# Check MongoDB Memory Server is installed
npm list mongodb-memory-server
bun list mongodb-memory-server
```
### Frontend
TEST_IMPLEMENTATION_SUMMARY.md
+12 -12
View File
@@ -427,41 +427,41 @@ All files | 54.75 | 32.23 | 62.66 | 54.85 |
```bash
# Run all tests
npm test
bun test
# Run tests in watch mode
npm run test:watch
bun run test:watch
# Run tests with coverage
npm run test:coverage
bun run test:coverage
# Run tests with verbose output
npm run test:verbose
bun run test:verbose
# Run specific test file
npm test -- auth.test.js
bun test -- auth.test.js
# Run tests matching pattern
npm test -- --testNamePattern="login"
bun test -- --testNamePattern="login"
```
### Frontend
```bash
# Run tests in watch mode (default)
npm test
bun test
# Run tests with coverage
npm run test:coverage
bun run test:coverage
# Run tests in watch mode (explicit)
npm run test:watch
bun run test:watch
# Run specific test file
npm test -- Login.test.js
bun test -- Login.test.js
# Run tests matching pattern
npm test -- --testNamePattern="should render"
bun test -- --testNamePattern="should render"
```
---
@@ -670,7 +670,7 @@ npm test -- --testNamePattern="should render"
- Expected impact: Increase passing tests to 140+
2. **Run Frontend Coverage Report**
- Execute `npm run test:coverage` in frontend
- Execute `bun run test:coverage` in frontend
- Establish baseline coverage metrics
- Identify coverage gaps
backend/Dockerfile
+5 -5
View File
@@ -1,5 +1,5 @@
# Multi-stage build for ARM compatibility (Raspberry Pi)
FROM node:18-alpine AS builder
FROM oven/bun:1-alpine AS builder
WORKDIR /app
@@ -7,13 +7,13 @@ WORKDIR /app
COPY package*.json ./
# Install dependencies
RUN npm ci --only=production
RUN bun install --frozen-lockfile --production
# Copy source code
COPY . .
# --- Production stage ---
FROM node:18-alpine
FROM oven/bun:1-alpine
# Install curl for health checks
RUN apk add --no-cache curl
@@ -32,7 +32,7 @@ EXPOSE 5000
# Health check
HEALTHCHECK --interval=30s --timeout=3s --start-period=40s \
CMD node -e "require('http').get('http://localhost:5000/api/health', (r) => {process.exit(r.statusCode === 200 ? 0 : 1)})"
CMD bun -e "fetch('http://localhost:5000/api/health').then(r=>process.exit(r.ok?0:1))"
# Start server
CMD ["node", "server.js"]
CMD ["bun", "server.js"]
backend/IMPLEMENTATION_SUMMARY.md
+6 -6
View File
@@ -89,7 +89,7 @@ This document summarizes the critical backend features implemented for the Adopt
**Seeder Script:**
- `/scripts/seedBadges.js` - Seeds initial 19 badges
- Run with: `npm run seed:badges`
- Run with: `bun run seed:badges`
---
@@ -320,7 +320,7 @@ Point-awarding endpoints now return additional data:
### Initial Setup
1. Install dependencies (already done):
```bash
npm install
bun install
```
2. Configure environment variables:
@@ -331,21 +331,21 @@ Point-awarding endpoints now return additional data:
3. Seed badges:
```bash
npm run seed:badges
bun run seed:badges
```
4. Start server:
```bash
npm run dev
bun run dev
```
### Verify Installation
```bash
# Check for linting errors
npx eslint .
bunx eslint .
# Run tests
npm test
bun test
```
---
deploy/README.md
+1
View File
@@ -33,6 +33,7 @@ deploy/
- Docker with buildx for multi-arch builds
- kubectl CLI tool
- Access to container registry (Docker Hub, GitHub Container Registry, or private registry)
- Bun runtime for local development and testing
## Quick Start
frontend/Dockerfile
+3 -3
View File
@@ -1,5 +1,5 @@
# Multi-stage build for ARM compatibility (Raspberry Pi)
FROM node:18-alpine AS builder
FROM oven/bun:1-alpine AS builder
WORKDIR /app
@@ -7,13 +7,13 @@ WORKDIR /app
COPY package*.json ./
# Install dependencies
RUN npm ci
RUN bun install --frozen-lockfile
# Copy source code
COPY . .
# Build production bundle
RUN npm run build
RUN bun run build
# --- Production stage with nginx ---
FROM nginx:alpine
frontend/README.md
+5 -5
View File
@@ -6,7 +6,7 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo
In the project directory, you can run:
### `npm start`
### `bun start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
@@ -14,12 +14,12 @@ Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
The page will reload when you make changes.\
You may also see any lint errors in the console.
### `npm test`
### `bun test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
### `bun run build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
@@ -29,7 +29,7 @@ Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
### `bun run eject`
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
@@ -65,6 +65,6 @@ This section has moved here: [https://facebook.github.io/create-react-app/docs/a
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
### `bun run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)