Welcome to the base React/Typscript project of MarineFox/xWyvernPx. It provides a solid foundation with essential tools and configurations to kickstart your React development.
- React: A popular JavaScript library for building user interfaces.
- TypeScript: A statically typed superset of JavaScript, providing better tooling and code quality.
- Vite: A fast, modern build tool for front-end development.
- ESLint: A linter for identifying and fixing code style and potential issues.
- Prettier: An opinionated code formatter that enforces a consistent code style.
- Husky: Git hooks made easy, ensuring code quality and consistency.
- Storybook: A development environment for designing, testing, and documenting UI components.
- Tailwind CSS: A utility-first CSS framework for creating flexible and responsive designs.
- Styled-components: A CSS-in-JS library for writing styled components with ease.
- React Router: A popular library for adding routing to your React applications.
- React Query: A powerful library for managing, caching, and syncing server-state in React applications.
- Recoil: An experimental state management library for React applications.
- GraphQL Request: A minimal GraphQL client for making requests to a GraphQL server.
- Framer Motion: A production-ready motion library for creating smooth animations in React.
- i18next: An internationalization framework for handling translations in your app.
- Sentry: A tool for tracking and monitoring errors in your application.
- Cypress: A fast and reliable end-to-end testing framework.
- UUID/Nanoid: A library for generating and working with UUIDs.
To get started with this boilerplate, follow these steps:
- Clone this repository to your local machine.
git clone <repository-url>- Install project dependencies.
npm install
#or
pnpm install- Start the development server.
npm run dev
#or
pnpm installYour React app should now be running locally on http://localhost:3000.
In the project directory, you can run the following scripts:
npm run dev: Starts the development server.npm run build: Builds the production-ready app.npm run lint: Runs ESLint to check your code for linting errors.npm run preview: Starts a production server to preview your built app.npm run storybook: Launches the Storybook development environment.npm run build-storybook: Builds the Storybook documentation.
If you'd like to contribute to this project or report issues, please follow our contribution guidelines.
This project is licensed under the MIT License - see the LICENSE file for details.
Happy coding! 👩💻👨💻
© Copyright 2023 by MarineFox/xWyvernPx