Varsarr

Overview

The VarsarrCodeQL workflow is a Vite boilerplate that allows developers to quickly set up a project using React, TypeScript, Axios, Styled-Components, Recoil, and React-Query. It also includes ESLint and Prettier integration and utilizes GitHub Actions for automatic dependency updates and CodeQL analysis.

Features

• Vite with React, TypeScript, and absolute imports
• ESLint and Prettier integration on VSCode
• GitHub Actions for automatic dependency updates (Renovate) and CodeQL Analysis

Installation

1. Use this repository as a GitHub template or clone it using degit with an empty git history:

npx degit repository-name my-project
cd my-project

2. Install the dependencies:

npm install

or

yarn install

3. Checklist:
   • If you don’t plan to use GitHub Actions, delete the .github folder.
   • Change the name field in package.json.
   • Modify or delete the LICENSE file.
   • Change the title, description, and theme color in the index.html.
   • Change the options in the vite.config.ts and tsconfig.ts files as desired.
   • If needed, change the React-Query options in src/components/providers.
   • Adjust the global styles in the lib/GlobalStyles.ts file.

Summary

The VarsarrCodeQL workflow is a powerful Vite boilerplate that simplifies the process of setting up a project with React, TypeScript, and various popular libraries. It offers features like ESLint and Prettier integration, automatic dependency updates with GitHub Actions, and CodeQL analysis. The installation process is straightforward, allowing developers to quickly start working on their projects.