Checkmark

Overview

Checkmark is a modern web application built with React, TypeScript, and Vite. It leverages sass for styling and uses ESLint and Prettier for code quality and formatting.

Prerequisites

• Node.js (20.x)
• npm
• It is recommended to maintain the node version using nvm (Node Version Manager)

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/checkmark.git
   cd checkmark

2. Set node version: (if you're using nvm)

   nvm use

3. Install the dependencies:

   npm install

Scripts

• Development Server: Start the development server with hot reloading.

  npm run dev

• Build: Build the project for production.

  npm run build

• Preview: Preview the production build locally.

  npm run preview

• Lint: Run ESLint to check for linting errors.

  npm run lint

• Lint Fix: Run ESLint and automatically fix linting errors.

  npm run lint:fix

• Format: Format the code using Prettier.

  npm run format

• Format Check: Check the code formatting using Prettier.

  npm run format:check

• Prepare: Prepare the project for Husky.

  npm run prepare

Technologies Used

• React: A JavaScript library for building user interfaces.
• TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
• Vite: A fast build tool and development server.
• Sass: A powerful professional grade CSS extension language .
• ESLint: A tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
• Prettier: An opinionated code formatter.
• PostCSS: A tool for transforming CSS with JavaScript plugins.
• Husky: Git hooks made easy.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details on how to contribute.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please see CODE_OF_CONDUCT.md for details on Code of Coonduct.

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.