Skip to content

hoangdloc/admin-base-reactjs

Repository files navigation

Admin Base ReactJS

This project serves as a base or boilerplate for future projects. It is built with React, TypeScript, and Vite, and includes a comprehensive ESLint configuration for code quality and consistency.

Features

  • React 18.2.0 with TypeScript
  • Vite for fast development and efficient builds
  • Comprehensive ESLint configuration for code quality and consistency
  • Tailwind CSS for utility-first CSS
  • Husky for Git hooks
  • Prettier for code formatting

Getting Started

  1. Clone the repository:
git clone https://github.com/yourusername/admin-base-reactjs.git
  1. Install the dependencies:
bun install
  1. Start the development server:
bun dev

Scripts

  • bun dev: Start the development server
  • bun build: Lint the code, compile TypeScript, and build the - project
  • bun lint: Lint the code
  • bun lint:fix: Automatically fix linting problems
  • bun format: Format the code with Prettier
  • bun preview: Preview the production build
  • bun test: Run tests with Vitest
  • bun test:coverage: Generate test coverage report

Contributing

Contributions are welcome! Please read our Contributing Guide for more information.

License

This project is licensed under the terms of the license specified in LICENSE.md.

Please replace https://github.com/yourusername/admin-base-reactjs.git with the actual URL of your repository. Also, you might want to create a CONTRIBUTING.md file if you plan to accept contributions from others.