Skip to content

Update README.md to reflect new repository architecture and project s… #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SamppaLHT merged 1 commit into from
Feb 20, 2026
Merged

Update README.md to reflect new repository architecture and project s… #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 74 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,28 +404,84 @@ Common HTTP status codes:
- `429`: Too Many Requests (rate limit exceeded)
- `500`: Internal Server Error

## Project Structure
## Repository Architecture

```
backend/
├── src/
│ ├── config/ # Configuration files
│ ├── controllers/ # Request handlers
│ ├── middleware/ # Custom middleware
│ ├── models/ # Database models
│ ├── routes/ # API route definitions
│ ├── services/ # Business logic
│ ├── types/ # Type definitions
│ └── utils/ # Helper functions
├── uploads/
│ └── avatars/ # Avatar image storage
├── .env.example # Environment variables template
├── docker-compose.ci.yml # Docker configuration
├── Dockerfile # Docker image definition
└── package.json # Dependencies and scripts

server/
├── database.sql # PostgreSQL database schema
├── LICENSE # License information
├── README.md # This documentation
│
└── backend/ # Main application directory
├── docker-compose.ci.yml # Docker Compose for CI/testing
├── Dockerfile # Container definition
├── package.json # Node.js dependencies and scripts
│
├── src/ # Source code
│ ├── index.js # Application entry point & server config
│ ├── PRIVACY_POLICY.html
│ │
│ ├── config/ # Configuration modules
│ │ ├── database.js # PostgreSQL connection pool
│ │ └── jwt.js # JWT token configuration
│ │
│ ├── controllers/ # Business logic & request handlers
│ │ ├── authController.js # User authentication & account management
│ │ ├── avatarController.js # Avatar upload & retrieval
│ │ ├── calendarEventController.js # Calendar event CRUD operations
│ │ ├── medicationController.js # Medication tracking
│ │ ├── petController.js # Pet profile management & sharing
│ │ ├── routeController.js # GPS route tracking
│ │ ├── vaccinationController.js # Vaccination records
│ │ ├── vetVisitController.js # Vet visit tracking
│ │ └── weightController.js # Weight monitoring
│ │
│ ├── middleware/ # Request processing pipeline
│ │ ├── authenticateToken.js # JWT validation
│ │ ├── avatarUpload.js # Multer file upload config
│ │ ├── resolveEffectiveUser.js # Multi-user & sub-user resolution
│ │ ├── validateLogin.js # Login input validation
│ │ ├── validateRegistration.js # Registration input validation
│ │ ├── validateSubUserRegistration.js # Sub-user creation validation
│ │ └── validateSubUserRoleUpdate.js # Role update validation
│ │
│ ├── models/ # Database access layer
│ │ ├── Avatar.js # Avatar database operations
│ │ ├── CalendarEvent.js # Calendar event queries
│ │ ├── Medication.js # Medication CRUD
│ │ ├── Pet.js # Pet profile & sharing logic
│ │ ├── Route.js # GPS route storage
│ │ ├── User.js # User & authentication queries
│ │ ├── Vaccination.js # Vaccination records
│ │ ├── VetVisit.js # Vet visit data
│ │ └── Weight.js # Weight tracking
│ │
│ ├── routes/ # API endpoint definitions
│ │ ├── avatarRoutes.js # /api/avatars/*
│ │ ├── calendarEventRoutes.js # /api/calendar-events/*
│ │ ├── medicationRoutes.js # /api/medications/*
│ │ ├── petRoutes.js # /api/pets/*
│ │ ├── routeRoutes.js # /api/routes/*
│ │ ├── userRoutes.js # /api/auth/*
│ │ ├── vaccinationRoutes.js # /api/vaccinations/*
│ │ ├── vetVisitRoutes.js # /api/vet-visits/*
│ │ └── weightRoutes.js # /api/weights/*
│ │
│ ├── services/ # Business logic services (reserved for future use)
│ │
│ ├── types/ # Type definitions (reserved for future use)
│ │
│ └── utils/ # Helper functions & utilities
│ ├── generateToken.js # JWT token generation
│ ├── hashPassword.js # bcrypt password hashing
│ └── shareCode.js # Pet sharing code generation
│
└── uploads/ # File storage
└── avatars/ # User & pet avatar images
```



## Development

### Running in Development Mode
Expand Down
Loading