Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Instructions and demo for running AP UI locally to aid development #3702

Closed
1 of 2 tasks
AntFMoJ opened this issue Mar 13, 2024 · 3 comments · Fixed by ministryofjustice/analytical-platform-ui#124
Closed
1 of 2 tasks
Assignees
Labels
data-platform-apps-and-tools This issue is owned by Data Platform Apps and Tools story

Comments

@AntFMoJ
Copy link
Contributor

AntFMoJ commented Mar 13, 2024

User Story

As a data engineer
I need instructions and a demo for running the AP UI locally
So that I can contribute to development on my local machine, bypassing the need to go through the whole CI cycle for each change I implement.

Value / Purpose

Having the ability to implement and test changes to the AP UI locally will mean that work can be executed and validated more quickly than if each change has to go through the full process of being integrated and deployed to the environment the (prod or dev) service is running.

Having the instructions documented alongside a demo of the steps will enable engineers to be able work on the project locally more efficiently and confidently.

Useful Contacts

No response

User Types

No response

Hypothesis

No response

Proposal

When running the AP UI locally, it would be useful to be able to ensure it integrates with external AWS services or databases.
This could include using mocking for these services.

Additional Information

No response

Definition of Done

  • Process for running locally documented
  • Demo of process given with the AP team in a huddle
@AntFMoJ AntFMoJ added story data-platform-apps-and-tools This issue is owned by Data Platform Apps and Tools labels Mar 13, 2024
@jamesstottmoj jamesstottmoj moved this from 👀 TODO to 🚀 In Progress in Analytical Platform Mar 20, 2024
@jamesstottmoj jamesstottmoj self-assigned this Mar 20, 2024
@jamesstottmoj
Copy link
Contributor

Guide written for running the new AP UI locally here

@jamesstottmoj
Copy link
Contributor

jamesstottmoj commented Apr 2, 2024

Updated readme to include instructions on how to run locally.
Post create script now also creates static assets and runs migrations
Updated readme can be viewed here

@jamesstottmoj
Copy link
Contributor

Waiting on PR review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment