chore: reuse ipld-explorer as git submodule #771
Closed
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 is the shortest path to re-using the ipld explorer code
in webui. Publishing ipld explorer as a reuseable module needs
more thought, and right now we want to be able to build and
edit all of the webui code from a single code base, while we
do the polishing for release.
To test it out, checkout
ipld-explore-as-git-submodule
and do the submodule danceYou only need to do that the once.
If you then need to edit ipld explorer code for the web ui project, you can
cd
into the explore directory, and you are now working in the scope of the ipld-explore repo. You'd make your changes there, as if you were working directly against the ipld-explorer repo (you are) and branch and push from inside theexplore
sub dir. Remeber that your changes need to make sense for both the standalone app and the webui. Once your happy with and you've pushed your ipld explorer changes, you cancd
back up to the webui root, and rungit status
and you'll see something likeWhich tells us that the ipld explore submodule in your local workspace has your new changes, but the submodule pointer from the parent webui project needs updating. If you add, commit and PR that change to webui, then you share that "update ipld explorer to this commit" with the team.
I already hate this, so will be working on a better solution asap.
In the future ipld explorer may become one app in a learna repo
for all the webui sections, or we might focus on a post-message
api to co-ordinate ipfs apps via iframes with webui orchestrating
things and providing the ipfs instance to child frames.
License: MIT
Signed-off-by: Oli Evans oli@tableflip.io