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

RFC: A sharp samples remover #24

Open
1 of 4 tasks
eric-burel opened this issue Jun 9, 2020 · 0 comments
Open
1 of 4 tasks

RFC: A sharp samples remover #24

eric-burel opened this issue Jun 9, 2020 · 0 comments
Labels

Comments

@eric-burel
Copy link
Collaborator

eric-burel commented Jun 9, 2020

Goal

Vulcan is a big framework. We want to include a lot of features for you to get started.
But sometimes, you need something simpler. Maybe you don't need MDX to write your doc, or you only want to keep the server. You may prefer a CSS solution to Material UI.

What's more annoying in a starter than needing to remove all the default samples?

We need to include a few code examples in Vulcan Next Starter, to demo features but also to be able to test that everything is ok.

Ideas

  • Isolate code samples, demos, and framework related stuff in folders named vn. The packages folder also isolates features.
  • Write a script that eject from Vulcan Next, to get a clean start.
  • Write scripts to remove specific features. UI libs like Material UI are a first good example
  • Put configs into .vn: even if you don't remove them, they are isolated and easier to locate and update

Getting rid of Material UI

Material UI is an opinionated choice, but we should at least be able to document where it impacts the app even if you want to use only some components

  • Material UI setups a default, global theme => remove the CSSBaseline component will remove styling of body
@eric-burel eric-burel changed the title A sharp samples remover RFC: A sharp samples remover Oct 12, 2020
@eric-burel eric-burel added the RFC label Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant