https://github.com/renatoxm/typescript-reactjs-starter
Non-opinionated TypeScript starter for React
https://github.com/renatoxm/typescript-reactjs-starter
reactjs starter starter-kit tyoescript vite vite-react vite-react-typescript vitejs
Last synced: 25 days ago
JSON representation
Non-opinionated TypeScript starter for React
- Host: GitHub
- URL: https://github.com/renatoxm/typescript-reactjs-starter
- Owner: renatoxm
- License: mit
- Created: 2023-03-19T14:30:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-20T12:42:25.000Z (about 3 years ago)
- Last Synced: 2025-07-26T14:52:08.062Z (10 months ago)
- Topics: reactjs, starter, starter-kit, tyoescript, vite, vite-react, vite-react-typescript, vitejs
- Language: CSS
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Typescript React.js Starter Kit
Non-opinionated TypeScript starter for React
## Features
- [x] ⚛️ React 18
- [x] ⛑ TypeScript
- [x] 📏 ESLint — To find and fix problems in your code
- [x] 💖 Prettier — Code Formatter for consistent style
- [x] 🐶 Husky — For running scripts before committing
- [x] 🚓 Commitlint — To make sure your commit messages follow the convention
- [x] 🚫 lint-staged — Run ESLint and Prettier against staged Git files
## Quick Start
The best way to start with this template
```sh
# pnpm
pnpm create next-app -e https://github.com/renatoxm/typescript-reactjs-starter
```
### Development
To start the project locally, run:
```sh
pnpm dev
```
Open `http://localhost:5173` with your browser to see the result.
## Documentation
### Requirements
- Node.js >= 12.22.0
- pnpm 7
### Directory Structure
- [`.github`](.github) — GitHub configuration including the CI workflow.
- [`.husky`](.husky) — Husky configuration and hooks.
- [`public`](./public) — Static assets such as robots.txt, images, and favicon.
- [`src`](./src) — Application source code, including pages, components, styles.
### Scripts
- `pnpm dev` — Starts the application in development mode at `http://localhost:5173`.
- `pnpm build` — Creates an optimized production build of your application.
- `pnpm start` — Starts the application in production mode.
- `pnpm type-check` — Validate code using TypeScript compiler.
- `pnpm lint` — Runs ESLint for all files in the `src` directory.
- `pnpm format` — Runs Prettier for all files in the `src` directory.
### Path Mapping
TypeScript are pre-configured with custom path mappings. To import components or files, use the `@` prefix.
```tsx
import { Button } from '@/components/Button';
// To import images or other files from the public folder
import avatar from '@/public/avatar.png';
```
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information.