README.adoc

react-skeleton

React skeleton to kick-start your new application.

Table of Contents

• 1. What is included?
• 2. Usage
  • 2.1. Run locally
  • 2.2. Build for deployment
• 3. Testing
• 4. Code formatting
• 5. Eslint
• 6. License

1. What is included?

• Typescript

• Vite

• Chakra UI

• React Icons

• React Hook Form

• React Query

• React Router

• Axios

• date-fns

• i18next

• Custom strict Eslint config

• Prettier

• Vitest

• Testing Library

• Optional integration with BojanStipic/spring-skeleton

2. Usage

2.1. Run locally

npm ci
npm run dev

2.2. Build for deployment

npm run build

3. Testing

Run tests:

npm run test

Run tests and open the UI summary:

npm run test:ui

Check code coverage:

npm run test:coverage

4. Code formatting

npm run fmt

5. Eslint

npm run lint

6. License

Copyright (C) 2022-2023 Bojan Stipic

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.