Skip to content
This repository has been archived by the owner on Feb 8, 2021. It is now read-only.

Refactor the code #36

Open
avaer opened this issue Jun 11, 2020 · 2 comments
Open

Refactor the code #36

avaer opened this issue Jun 11, 2020 · 2 comments

Comments

@avaer
Copy link
Contributor

avaer commented Jun 11, 2020

Right now this xrpackage respository is doing far too many things.

This was useful during the experimentation phase (for convenience), but the monolithic nature of this repository is making it hard for contributors to onboard.

Here are some of the independent pieces in this repo:

Note that the xrpackage-cli repo is already completely separate from this one; the CLI is still kind of monolithic but nowhere near to the degree of this repository, since it does a lot less.

I wouldn't advocate for splitting this functionality into 10 repositories right now but there are some clear contenders of things that should be separate. For example, the core API (xrpackage.js) and the frontend site pages for xrpackage.org (index.html, browse.html, etc.) should probably not be in the same repo.

Opening this issue to get the discussion started for the right path forward.

@avaer
Copy link
Contributor Author

avaer commented Jun 11, 2020

Moving the HTML site to be separate from the core might be a good start (index.html, edit.html, run.html, browse.html, inspect.html, and dependencies).

If we do that then probably static.xrpackage.org could be this repo, while xrpackage.org becomes the frontend site extracted out.

Some urls might need to be updated in that case, since many repositories are for example dynamically loading https://xrpackage.org/xrpackage.js on the frontend.

@shu8
Copy link
Contributor

shu8 commented Jun 15, 2020

@avaer Is there a repo that already exists where we could start to move out the xrpackage.org front-end files to?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants