Restructure GovTool monorepo #85

kickloop · 2024-01-29T11:14:05Z

As discussed, GovTool monorepo is restructured and you guys need to reconfigure the codebase to work with the new files and folder structure. Feel free to ping me bellow in the comment section if you have any questions. In fact, let's use the comments section bellow to discuss and come up with solutions.

The branch: https://github.com/IntersectMBO/govtool/tree/restructuring

adgud · 2024-01-31T10:15:48Z

Link to Slack discussion for reference: https://binarapps.slack.com/archives/C06D81ZF11P/p1706098189116189

@adgud

This commit updates the README.md file to align with the new backend/frontend naming convention for the SanchoNet GovTool project, as part of the ongoing effort detailed in ticket #85. Previously, the documentation links used the old 'vva-be' and 'vva-fe' naming, which is now replaced with 'backend' and 'frontend' respectively. This change ensures consistency across our project documentation, following the updates made by @adgud.

@adgud

This commit involves updating the README.md files for both the backend and frontend components of the GovTool project. These changes are part of the ongoing efforts for ticket #85, ensuring that all references to the old 'vva-be' and 'vva-fe' codenames are replaced with the new 'backend' and 'frontend' naming convention. This is a continuation of the work done by @adgud, aiming to maintain consistency across the project's documentation and directory structure.

This commit updates the DEPLOY.md documentation in the docs/operations folder, as part of the work outlined in ticket #85. The purpose of these changes is to ensure that our deployment documentation reflects the new naming convention. Technical Details: - Updated the reference in the AWS setup instructions, changing the directory path from `./src/terraform` to `./infra/terraform`. This reflects the new directory structure under the 'infra' directory.

In this commit, we're updating the docker-compose.yml file within the scripts/govtool directory. This is in line with the ongoing efforts for ticket #85, focusing on aligning all parts of our project with the new backend/frontend naming convention. This update changes the build contexts for both the backend and frontend services in the Docker Compose configuration, replacing the outdated paths with the new ones that reflect our current project structure. This is an important step to ensure consistency across all our development and deployment tools. Technical Details: - The build context for the 'vva-be' service in docker-compose.yml was updated from `vva-be` to `../../govtool/backend`. - Similarly, the build context for the 'vva-fe' service was changed from `vva-fe` to `../../govtool/frontend`.

This commit involves renaming various configuration files related to the backend service of the GovTool project. The change is part of the ongoing work for ticket #85, where we're aligning all aspects of the project with the new backend/frontend naming convention. This update specifically targets the configuration files, changing the 'vva-be' references to 'backend'. Technical Details: - Renamed the configuration file from `.github/vva-be-config.json` to `.github/backend-config.json`. - Updated the configuration file paths in the scripts/govtool directory, changing from `scripts/govtool/config/secrets/vva-be-config.json` and `scripts/govtool/config/secrets/vva-be-config.json.tpl` to `scripts/govtool/config/secrets/backend-config.json` and `scripts/govtool/config/secrets/backend-config.json.tpl` respectively. - In both the `docker-compose.yml` and `docker-compose.sanchonet.yml` files, updated the command and secrets sections to use the new `backend-config.json` file. This ensures that the Docker containers for the backend service use the correct configuration file when deployed. - Updated the `prepare-config.sh` script to replace the old template path with the new `backend-config.json.tpl`, ensuring the script correctly generates the required configuration files for deployment and development environments.

This commit focuses on renaming container services in various Docker Compose and Grafana configuration files as part of the efforts detailed in ticket #85. The goal is to align all service names with the new backend/frontend naming convention. Technical Details: - In the Grafana provisioning alerting configuration (alerting.yml), updated the Prometheus expression to use `backend@docker` instead of `vva-be@docker`. This change is crucial for accurate monitoring and alerting based on the new service names. - Updated the Grafana dashboard configuration (vva.json), changing the Prometheus expression to reference `frontend@docker` instead of `vva-fe@docker`. This ensures that the dashboard accurately reflects the traffic and metrics for the frontend service. - In both the `docker-compose.sanchonet.yml` and `docker-compose.yml` files, renamed the services from `vva-be` to `backend` and from `vva-fe` to `frontend`. This update affects how these services are referenced and managed within our Docker Compose environments, aligning them with the new project naming standards.

…rvices This commit revises the Traefik configuration labels within our Docker Compose files (docker-compose.yml and docker-compose.sanchonet.yml), as part of the work specified in ticket #85. The aim is to replace the old 'vva-be' and 'vva-fe' labels with 'backend' and 'frontend', in line with the new naming convention adopted across the project. Technical Details: - In the `docker-compose.sanchonet.yml` file, updated all Traefik labels for the backend service, replacing 'vva-be' with 'backend'. This includes updates to router rules, middlewares, and service definitions. - Similarly, updated the frontend service labels in the same file, changing 'vva-fe' to 'frontend'. This change affects router rules and service definitions, ensuring the frontend service is correctly identified and routed by Traefik. - Made analogous updates in the `docker-compose.yml` file, ensuring that local development environments also reflect these changes. This includes updating the Traefik labels for both the backend and frontend services to use the new service names.

This commit updates the volume mappings for the FakeDB database schema in the docker-compose.yml file, as a part of the work detailed in ticket #85. The modification is necessary to reflect the new backend/frontend naming convention and directory structure in the GovTool project. Specifically, this change ensures that the database initialization scripts for the FakeDB service are correctly sourced from the updated locations within the project. Technical Details: - Changed the volume mappings for the FakeDB service within the docker-compose.yml file. The paths for the database initialization scripts 'fakedbsync_users.sql' and 'schema6.sql' have been updated from `./vva-be/misc/...` to `../../govtool/backend/misc/...`. - This update ensures that when the FakeDB service is started, it correctly locates and executes the initialization scripts stored in the new backend directory, maintaining the integrity and functionality of the development environment.

…docker compose This commit changes the local domain names for the backend and frontend services in the docker-compose.yml file, as part of the initiative in ticket #85. The modification is aimed at aligning the local development environment with the new backend/frontend naming convention. By updating the domain names, we ensure that the local URLs used for accessing these services reflect the updated project structure and naming standards. Technical Details: - Updated the Traefik router rule for the backend service. The local domain name is changed from `vva-be.localhost` to `backend-govtool.localhost`. This alteration is specified in the label `traefik.http.routers.backend.rule`. - For the frontend service, updated the Traefik router rule to change its local domain from `vva-fe.localhost` to `frontend-govtool.localhost`. This change is reflected in the label `traefik.http.routers.frontend.rule`.

This commit focuses on renaming container services in various Docker Compose and Grafana configuration files as part of the efforts detailed in ticket #85. The goal is to align all service names with the new backend/frontend naming convention. Technical Details: - In the Grafana provisioning alerting configuration (alerting.yml), updated the Prometheus expression to use `backend@docker` instead of `vva-be@docker`. This change is crucial for accurate monitoring and alerting based on the new service names. - Updated the Grafana dashboard configuration (vva.json), changing the Prometheus expression to reference `frontend@docker` instead of `vva-fe@docker`. This ensures that the dashboard accurately reflects the traffic and metrics for the frontend service. - In both the `docker-compose.sanchonet.yml` and `docker-compose.yml` files, renamed the services from `vva-be` to `backend` and from `vva-fe` to `frontend`. This update affects how these services are referenced and managed within our Docker Compose environments, aligning them with the new project naming standards.

…rvices This commit revises the Traefik configuration labels within our Docker Compose files (docker-compose.yml and docker-compose.sanchonet.yml), as part of the work specified in ticket #85. The aim is to replace the old 'vva-be' and 'vva-fe' labels with 'backend' and 'frontend', in line with the new naming convention adopted across the project. Technical Details: - In the `docker-compose.sanchonet.yml` file, updated all Traefik labels for the backend service, replacing 'vva-be' with 'backend'. This includes updates to router rules, middlewares, and service definitions. - Similarly, updated the frontend service labels in the same file, changing 'vva-fe' to 'frontend'. This change affects router rules and service definitions, ensuring the frontend service is correctly identified and routed by Traefik. - Made analogous updates in the `docker-compose.yml` file, ensuring that local development environments also reflect these changes. This includes updating the Traefik labels for both the backend and frontend services to use the new service names.

This commit updates the volume mappings for the FakeDB database schema in the docker-compose.yml file, as a part of the work detailed in ticket #85. The modification is necessary to reflect the new backend/frontend naming convention and directory structure in the GovTool project. Specifically, this change ensures that the database initialization scripts for the FakeDB service are correctly sourced from the updated locations within the project. Technical Details: - Changed the volume mappings for the FakeDB service within the docker-compose.yml file. The paths for the database initialization scripts 'fakedbsync_users.sql' and 'schema6.sql' have been updated from `./vva-be/misc/...` to `../../govtool/backend/misc/...`. - This update ensures that when the FakeDB service is started, it correctly locates and executes the initialization scripts stored in the new backend directory, maintaining the integrity and functionality of the development environment.

…docker compose This commit changes the local domain names for the backend and frontend services in the docker-compose.yml file, as part of the initiative in ticket #85. The modification is aimed at aligning the local development environment with the new backend/frontend naming convention. By updating the domain names, we ensure that the local URLs used for accessing these services reflect the updated project structure and naming standards. Technical Details: - Updated the Traefik router rule for the backend service. The local domain name is changed from `vva-be.localhost` to `backend-govtool.localhost`. This alteration is specified in the label `traefik.http.routers.backend.rule`. - For the frontend service, updated the Traefik router rule to change its local domain from `vva-fe.localhost` to `frontend-govtool.localhost`. This change is reflected in the label `traefik.http.routers.frontend.rule`.

This commit updates the Makefile within the scripts/govtool directory to reflect the new project naming conventions as outlined in ticket #85. The change involves renaming the Docker Compose project from the old 'vva' prefix to 'govtool'. This renaming is crucial to maintain consistency throughout the project's infrastructure and deployment scripts, aligning them with the updated naming standards. Technical Details: - Modified the Docker Compose commands in the Makefile. Changed the project name prefix in the `-p` (project name) option from `vva-$(env)-$(cardano_network)` to `govtool-$(env)-$(cardano_network)`. This affects both the `deploy-stack` and `toggle-maintenance` targets in the Makefile. - These changes ensure that when deploying or managing the Docker Compose stacks, the correct, updated project name is used, which is vital for proper identification and management of the containers in different environments.

This commit focuses on updating the database name for the FakeDB service from 'vva' to 'govtool'. This change is made across various configuration files and workflows as part of the efforts described in ticket #85. The update is essential to ensure that the database name aligns with the new backend/frontend naming convention and provides consistency across the project's development, testing, and deployment environments. Technical Details: - Updated the `backend-config.json` file in the `.github` directory and the `scripts/govtool/config/secrets` directory. Changed the 'dbname' field from 'vva' to 'govtool' in the 'fakedbsyncconfig' object. - Modified the `.github/workflows/build-and-deploy.yml` file, updating the `FAKEDBSYNC_POSTGRES_DB` environment variable from 'vva' to 'govtool'. This change ensures that the GitHub Actions workflows utilize the correct database name during build and deployment processes. - Changed the `FAKEDBSYNC_POSTGRES_DB` variable in the `.env.example` file in the `scripts/govtool` directory, ensuring that local development environments are correctly configured to use the new database name. - In the `docker-compose.yml` file within the `scripts/govtool` directory, updated the `POSTGRES_DB` environment variable for the postgres service from 'vva' to 'govtool'. This ensures that the correct database is created and used when running the Docker Compose setup.

This commit updates the README.md file in the govtool/backend directory, adding a crucial note regarding the potential renaming of the backend executable. As part of the ongoing efforts outlined in ticket #85, this note is essential to prepare for the upcoming changes that align with the project's rebranding and development strategies. This note informs readers and developers that the executable previously known as 'vva-be' is anticipated to be officially renamed to 'govtool-backend'. The change is in line with the project's updated branding and functional scope. It is planned to be implemented soon as part of a planned refactor

@adgud

This commit updates the README.md file to align with the new backend/frontend naming convention for the SanchoNet GovTool project, as part of the ongoing effort detailed in ticket #85. Previously, the documentation links used the old 'vva-be' and 'vva-fe' naming, which is now replaced with 'backend' and 'frontend' respectively. This change ensures consistency across our project documentation, following the updates made by @adgud.

@adgud

This commit involves updating the README.md files for both the backend and frontend components of the GovTool project. These changes are part of the ongoing efforts for ticket #85, ensuring that all references to the old 'vva-be' and 'vva-fe' codenames are replaced with the new 'backend' and 'frontend' naming convention. This is a continuation of the work done by @adgud, aiming to maintain consistency across the project's documentation and directory structure.

This commit updates the DEPLOY.md documentation in the docs/operations folder, as part of the work outlined in ticket #85. The purpose of these changes is to ensure that our deployment documentation reflects the new naming convention. Technical Details: - Updated the reference in the AWS setup instructions, changing the directory path from `./src/terraform` to `./infra/terraform`. This reflects the new directory structure under the 'infra' directory.

In this commit, we're updating the docker-compose.yml file within the scripts/govtool directory. This is in line with the ongoing efforts for ticket #85, focusing on aligning all parts of our project with the new backend/frontend naming convention. This update changes the build contexts for both the backend and frontend services in the Docker Compose configuration, replacing the outdated paths with the new ones that reflect our current project structure. This is an important step to ensure consistency across all our development and deployment tools. Technical Details: - The build context for the 'vva-be' service in docker-compose.yml was updated from `vva-be` to `../../govtool/backend`. - Similarly, the build context for the 'vva-fe' service was changed from `vva-fe` to `../../govtool/frontend`.

This commit involves renaming various configuration files related to the backend service of the GovTool project. The change is part of the ongoing work for ticket #85, where we're aligning all aspects of the project with the new backend/frontend naming convention. This update specifically targets the configuration files, changing the 'vva-be' references to 'backend'. Technical Details: - Renamed the configuration file from `.github/vva-be-config.json` to `.github/backend-config.json`. - Updated the configuration file paths in the scripts/govtool directory, changing from `scripts/govtool/config/secrets/vva-be-config.json` and `scripts/govtool/config/secrets/vva-be-config.json.tpl` to `scripts/govtool/config/secrets/backend-config.json` and `scripts/govtool/config/secrets/backend-config.json.tpl` respectively. - In both the `docker-compose.yml` and `docker-compose.sanchonet.yml` files, updated the command and secrets sections to use the new `backend-config.json` file. This ensures that the Docker containers for the backend service use the correct configuration file when deployed. - Updated the `prepare-config.sh` script to replace the old template path with the new `backend-config.json.tpl`, ensuring the script correctly generates the required configuration files for deployment and development environments.

This commit focuses on renaming container services in various Docker Compose and Grafana configuration files as part of the efforts detailed in ticket #85. The goal is to align all service names with the new backend/frontend naming convention. Technical Details: - In the Grafana provisioning alerting configuration (alerting.yml), updated the Prometheus expression to use `backend@docker` instead of `vva-be@docker`. This change is crucial for accurate monitoring and alerting based on the new service names. - Updated the Grafana dashboard configuration (vva.json), changing the Prometheus expression to reference `frontend@docker` instead of `vva-fe@docker`. This ensures that the dashboard accurately reflects the traffic and metrics for the frontend service. - In both the `docker-compose.sanchonet.yml` and `docker-compose.yml` files, renamed the services from `vva-be` to `backend` and from `vva-fe` to `frontend`. This update affects how these services are referenced and managed within our Docker Compose environments, aligning them with the new project naming standards.

- Added entries for issues #85, #97, #171, and #181 in the Changelog: - Fixed deployment scripts to resolve Issue #171. - Updated Node and DbSync versions for Issue #181, enhancing system compatibility. - Reorganized repository structure for better alignment with new conventions, addressing Issue #85. - Renamed project to GovTool as part of rebranding efforts for Issue #97. - Categorized each issue under the appropriate section: new feature, fix, or change. - Linked each issue to its corresponding URL for detailed reference.

@adgud

This commit updates the README.md file to align with the new backend/frontend naming convention for the SanchoNet GovTool project, as part of the ongoing effort detailed in ticket #85. Previously, the documentation links used the old 'vva-be' and 'vva-fe' naming, which is now replaced with 'backend' and 'frontend' respectively. This change ensures consistency across our project documentation, following the updates made by @adgud.

@adgud