strix-backend/releaseNotes.txt at main · CleanCodeIt/strix-backend · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# Strix Backend Release Notes

## Version 1.5.0 (May 6, 2025)

### Features
- Added complete licitation management system with CRUD operations
- Implemented Licitation model with title, description, start/end dates, and price type preference
- Created secure routes with authentication requirements for creating, updating, and deleting licitations
- Added comprehensive Swagger documentation for all licitation endpoints
- Implemented data validation for licitations (e.g., end date must be after start date)
- Added relationship between User and Licitation models

### Technical Notes
- Using Sequelize ORM for database interactions and relationships
- Added authentication middleware for protected licitation operations
- Implemented proper error handling and validation for all licitation operations
- Created comprehensive Swagger documentation with request/response examples
- Followed functional programming principles with immutable data patterns

## Version 1.4.1 (May 6, 2025)

### Fixes
- Fixed user registration error caused by improperly imported Sequelize operators
- Enhanced error handling during registration process with more descriptive error messages
- Implemented consistent usage of Sequelize Op object throughout auth routes

### Technical Notes
- Properly imported Sequelize Op object for complex database queries
- Added detailed error reporting for better debugging and user experience
- Improved error handling for Sequelize validation and unique constraint errors

## Version 1.4.0 (May 6, 2025)

### Features
- Implemented complete user authentication system with JWT tokens
- Added user registration endpoint with automatic admin role for first user
- Created login endpoint with secure password handling
- Added protected routes using authentication middleware
- Implemented role-based access control (admin vs regular users)
- Enhanced User model with isAdmin field

### Technical Notes
- Using bcryptjs for secure password hashing
- JWT tokens for stateless authentication
- Middleware for protecting routes and enforcing admin access
- First registered user in the system automatically becomes admin
- Added Swagger documentation for all authentication endpoints

## Version 1.3.0 (May 6, 2025)

### Features
- Added PostgreSQL database integration with environment variable configuration
- Implemented automatic database migrations on application startup
- Created User model and migration example
- Added database connection status endpoint at /db-status
- Implemented migration management system with Umzug

### Technical Notes
- Using Sequelize ORM with PostgreSQL driver
- Environment variables for database connection stored in .env file
- Automatic migration system ensures database schema is always up to date
- Added helper scripts for managing database migrations and seeds
- Created basic User model structure as foundation for authentication

## Version 1.2.1 (May 6, 2025)

### Features
- Fixed Swagger configuration to support dynamic server URLs instead of hardcoded localhost
- Added environment detection for proper Swagger documentation in production deployments
- Implemented server selector in Swagger UI for better environment handling

### Technical Notes
- Now using NODE_ENV to detect environment and adjust Swagger URLs accordingly
- Added server variables in Swagger configuration for better URL handling
- Fixed issue with Swagger showing http://localhost:3000 URLs in production deployment

## Version 1.2.0 (May 6, 2025)

### Features
- Implemented proper build process with Babel
- Added ESLint configuration for code quality enforcement
- Created optimized production builds via npm run build
- Updated GitHub Actions workflow to use the new build system

### Technical Notes
- Babel configured to target Node.js 18 environment
- ESLint rules enforce functional programming patterns
- Build process creates minified artifacts in the dist directory
- Updated deployment workflow to leverage the new build process

## Version 1.1.0 (May 6, 2025)

### Features
- Added GitHub Actions automated deployment workflow
- Implemented FTP deployment functionality
- Added automatic GitHub release creation based on version in commit messages
- Configured build artifact packaging for releases

### Technical Notes
- GitHub Actions workflow triggers only on specific commit message format: `DEPLOY {version}: {commitMessage}`
- Secured FTP credentials and server information using GitHub Secrets
- Integrated build artifacts with GitHub Releases

## Version 1.0.0 (May 6, 2025)

### Features
- Initial project setup with Express.js
- Implemented Hello World GET route at /hello
- Added Swagger API documentation at /api-docs
- Configured development environment with nodemon for auto-reload

### Technical Notes
- Following functional programming principles
- Implemented proper error handling with try/catch blocks
- API documentation compliant with OpenAPI 3.0.0 specification