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

[chore] Separate website/elements/apps from library? #434

Open
LeaVerou opened this issue Feb 13, 2024 · 4 comments
Open

[chore] Separate website/elements/apps from library? #434

LeaVerou opened this issue Feb 13, 2024 · 4 comments

Comments

@LeaVerou
Copy link
Member

LeaVerou commented Feb 13, 2024

The current structure has served us well but we're at the point where we need to separate the two.

In terms of tests, presumably the JS tests will stay with the library, while the HTML tests (old and new) will live with the website.

Both will still deploy to the web, I’m thinking dev.colorjs.io for the library repo.

@LeaVerou
Copy link
Member Author

Where would the API docs live? Presumably they need access to the source, but perhaps that can be done by installing color.js as an npm package on the website repo and pointing typedoc to that?

@MysteryBlokHed
Copy link
Member

Where would the API docs live? Presumably they need access to the source, but perhaps that can be done by installing color.js as an npm package on the website repo and pointing typedoc to that?

That should work if we want to keep all website stuff together. Alternatively there could also be a Git submodule that links back to this repo, but that might be overcomplicating things.

@LeaVerou
Copy link
Member Author

Yeah, my opinion on this is that submodules are plague and must be avoided at all costs 😛

@LeaVerou LeaVerou changed the title [chore] Separate website from library [chore] Separate website/elements/apps from library? Apr 22, 2024
@LeaVerou
Copy link
Member Author

I’ve been thinking about this and I think it makes sense to also separate apps and elements into separate repos / separate npm packages / separate subdomains.

Especially as I plan a bit of a revamp of these, what do you think about separating them?
We could create an npm namespace and publish them as @colorjs/apps and @colorjs/elements.
Later down the line we may even want to separate elements into separate packages, but let’s cross that bridge when we get to it.

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

No branches or pull requests

2 participants