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

Add a feature part to the README #299

Closed
Tracked by #297
yoannfleurydev opened this issue Oct 26, 2022 · 3 comments
Closed
Tracked by #297

Add a feature part to the README #299

yoannfleurydev opened this issue Oct 26, 2022 · 3 comments

Comments

@yoannfleurydev
Copy link
Member

yoannfleurydev commented Oct 26, 2022

At the moment, the README is really centered around technologies. This is fearful for new users. At @BearStudio, we think that it will be better to list feature of the starter instead of technologies, as the features may remain the same even if a technology may change.

Feel free to comment on this issue with a list of features that you find useful or feel free to join our Discord server to answer this discussion

@ivan-dalmet
Copy link
Member

For me, the features that I like in Start UI:

  • Chakra UI setup with custom theme (brand color, @primary button, ...) and type generation.
  • Basic responsive layout setup (navbar, page)
  • Extra common components (like Field*)
  • CRUD like example
  • Log In / Sign In flow
  • ESLint / Prettier / Husky setup
  • i18n setup if needed

@DecampsRenan
Copy link
Contributor

IMO, features I like:

  • Great list of pre-build components
  • Already existing Fields ready to use in Forms, with some nice defaults (only show errors after a submit, etc..)
  • Routes already setup with guards if needed
  • Storybook already setup with a lot of examples
  • Admin view (but I think we should make it more agnostic, it is really tied to JHipster right now)
  • Sign in / Sign up flow
  • i18n already setup
  • Many examples for making requests, customizing chakra ui theme, page layout
  • Really easy to build and deploy

@HugoPerard
Copy link
Member

HugoPerard commented Nov 21, 2022

The features that I find useful :

  • Config (ts, linter, translation, etc...), juste have to focus on app development
  • Routing setup
  • Most commons components
  • Required app screens (login, account, admin, etc..)
  • Basic theme setup, easily customizable

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

4 participants