Chore project refinement #39
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
-Update backend server configuration to use HTTPS -Modify frontend API calls to use HTTPS endpoints -Generate and implement SSL/TLS certificates
-Remove .env files from Git cache -Add .env to .gitignore to prevent future tracking Ensure sensitive information is no longer uploaded
-Create seeding scripts for initial data population -Implement logic to check for existing data before seeding -Add seeding process to server startup routine -Create seed data for users, objects, and other essential entities -Implement error handling and logging for seeding process
-Create @service layer to encapsulate business logic -Move business logic from controllers to services -Ensure controllers only interact with services, not repositories -Restructure code to improve modularity and reduce coupling
-Initialize Swagger JSDoc and Swagger UI integration -Create basic folder structure for API documentation -Add swagger.js configuration file -Set up initial swagger.js file -Prepare controllers for Swagger annotations -Add necessary dependencies for Swagger integration
-Create Swagger annotations for AuthController -Document login endpoint with request/response schemas -Add documentation for registration endpoint -Include JWT token information in response examples -Document error responses for authentication failures -Ensure all auth endpoints are properly tagged and categorized
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several significant improvements to our project's architecture, security, and documentation.
HTTPS Upgrade: Transitioned the entire application from HTTP to HTTPS for enhanced security.
Environment File Management: Removed .env files from Git tracking and updated .gitignore to prevent accidental exposure of sensitive information.
Automatic Database Seeding: Implemented a mechanism for automatic database seeding on server start, improving development workflow and data consistency.
Architecture Refactoring: Modified the application architecture to separate concerns and adhere to MVC principles, enhancing maintainability and scalability.
Swagger Documentation: Set up the basic structure for Swagger documentation and added comprehensive annotations for the AuthController, improving API discoverability and usability.