📖 Refactor analytical-platform-dashboard repository for use as the AP UI

michaeljcollinsuk commented 1 week ago

User Story

As a developer I need the analytical-platform-dashboard repo to be refactored So that it is ready to be used for the AP UI codebase

Value / Purpose

We need to implement the deployment process for the AP UI, and will use the existing analytical-platform-dashboard repo for the codebase. Before it can be used in a deployment, there is some foundational refactoring that needs to be completed so that it is fit for purpose

Useful Contacts

No response

User Types

No response

Hypothesis

If we... refactor the repo Then... we will be able to build the AP UI deployment process

Proposal

Refactor the codebase so that it can be deployed. Areas to focus:

Project structure. This should be made more "django".
Rename directories and paths
Page titles - remove any unwanted terms e.g. dashboard, control panel
Models/views/urls - remove any that were implemented for the original Quicksight POC that are no longer needed
Env vars/secrets - reduce to a minimum for the initial deployment, and make sure we have a list of those that will be needed in the helm chart
Rename the repository from analytical-platform-dashboard to analytical-platform-ui

Additional Information

Is a prerequisite for https://github.com/ministryofjustice/analytical-platform/issues/4456

Definition of Done

[x] Codebase refactored
[x] Repo renamed
[x] Image builds and runs locally

michaeljcollinsuk commented 1 week ago

Initial refactoring of the project structure underway in https://github.com/ministryofjustice/analytical-platform-dashboard/pull/172/files

michaeljcollinsuk commented 6 days ago

Updated the .env file example stored in 1password to use new values

ministryofjustice / analytical-platform