MatthausZillig / react-boilerplate-ts

React Typescript Boilerplate

This boilerplate uses dependabot and github actions for CI and to keep up to date.

🚀 What is inside?

This project uses lot of stuff as:

• TypeScript
• Vite
• Styled Components
• Jest
• Testing Library
• Eslint
• Prettier
• Husky

Getting Started

First install all dependencies and run the development server:

yarn
# or
npm install

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Commands

• dev: runs your application on localhost:3000
• build: creates the production build version
• preview: runs vite preview
• lint: runs the linter in all components and pages
• test: runs jest to test all components and pages
• test:watch: runs jest in watch mode
• test:coverage: runs jest coverage
• format: runs prettier write
• format:check runs prettier check

Learn More

To learn more about Vite.js, take a look at the following resources:

• Vite.js Documentation - learn about Vite.js.
• Vite.js config - learn about Vite configuration.

You can check out the Vite.js GitHub repository.

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.