diff --git a/.github/wiki/Home.md b/.github/wiki/Home.md new file mode 100644 index 0000000..57fa85e --- /dev/null +++ b/.github/wiki/Home.md @@ -0,0 +1,35 @@ +# Features list + +This template is based on top of the TypeScript version of [Create-React-App](https://create-react-app.dev/) toolkit and contains all its features. +In addition to Create-React-App, this templates provides the following features: + +## Development + +### Project Structure + +- A project structure matching our [React Project Strucutre](https://nimblehq.co/compass/development/code-conventions/javascript/react/#project-structure) conventions +- ESLint and Prettier — using our [custom ESLint configuration](https://github.com/nimblehq/eslint-config-nimble) +- SCSS support with our [conventional file structure](https://nimblehq.co/compass/development/code-conventions/css/#stylesheets-structure) +- Using `Dart SASS` with `@use` and `@forward` imports +- Absolute file imports + +### Helpers & Tools + +- [Axios](https://github.com/axios/axios) and a ready-to-use `requestManager` helper +- [Localization](https://github.com/nimblehq/react-templates/issues/34) using `i18next` +- [React Router](https://github.com/nimblehq/react-templates/issues/53) + +## Testing + +- [Cypress](https://nimblehq.co/compass/development/code-conventions/javascript/cypress/) confiugured for UI tests +- `data-test-id` [made consistent](https://github.com/nimblehq/react-templates/issues/30) across Cypress and Jest tests +- [Test coverage reports](https://github.com/nimblehq/react-templates/pull/38) — merging Cypress and Jest tests reports + +## GitHub + +- GitHub templates for Issues and Pull Requests +- GitHub workflows for Preview, Deployment and Tests + +## GitLab + +- GitLab templates for Merge Requests diff --git a/README.md b/README.md index 77bdda0..2c9d435 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@

Our template offers a rich boilerplate to jump-start React-based application development with [Create React App](https://github.com/facebook/create-react-app). +The complete list of features included in this template is available in [the project Wiki](https://github.com/nimblehq/react-templates/wiki). ## Getting Started