This pull request includes several significant updates to the GitHub Copilot usage and seat API project. The changes enhance the project's documentation, configuration management, and functionality for handling tenant and seat data. Below are the most important changes grouped by theme.
Documentation Improvements:
README.md: Updated the project description, added features, installation instructions, usage details, API endpoints, project structure, and tenant model information.
Configuration Management:
config.ts: Added environment variable loading using dotenv and created a Storage_Config class to manage configuration settings, including database parameters.
Functional Enhancements:
src/api/CopilotSeatStorageService.ts: Introduced a new service class for managing Copilot seat data, including methods for saving, retrieving, and querying seat data.
src/api/CopilotServiceFactory.ts: Added a factory class to create instances of usage and seat storage services based on the storage type (MySQL or file).
src/api/FileSeatStorage.ts: Implemented a file-based storage class for seat data, including methods for saving, retrieving, and querying data.
Package Updates:
package.json: Renamed the project to copilot-usage-saver and added dependencies for Swagger documentation (swagger-jsdoc and swagger-ui-express). [1][2]
These changes collectively improve the project's usability, configuration flexibility, and functionality for managing GitHub Copilot usage and seat data.
This pull request includes several significant updates to the GitHub Copilot usage and seat API project. The changes enhance the project's documentation, configuration management, and functionality for handling tenant and seat data. Below are the most important changes grouped by theme.
Documentation Improvements:
README.md: Updated the project description, added features, installation instructions, usage details, API endpoints, project structure, and tenant model information.Configuration Management:
config.ts: Added environment variable loading usingdotenvand created aStorage_Configclass to manage configuration settings, including database parameters.Functional Enhancements:
src/api/CopilotSeatStorageService.ts: Introduced a new service class for managing Copilot seat data, including methods for saving, retrieving, and querying seat data.src/api/CopilotServiceFactory.ts: Added a factory class to create instances of usage and seat storage services based on the storage type (MySQL or file).src/api/FileSeatStorage.ts: Implemented a file-based storage class for seat data, including methods for saving, retrieving, and querying data.Package Updates:
package.json: Renamed the project tocopilot-usage-saverand added dependencies for Swagger documentation (swagger-jsdocandswagger-ui-express). [1] [2]These changes collectively improve the project's usability, configuration flexibility, and functionality for managing GitHub Copilot usage and seat data.