LogoMkSaaS Docs

IDE Setup

Learn how to set up VSCode, Cursor, or other IDEs for optimal development with MkSaaS

MkSaaS comes with pre-configured settings for popular code editors like VSCode and Cursor to provide an optimal development experience. This guide will help you set up your editor for maximum productivity.

Cursor is a code editor built on top of VSCode that provides AI-assisted development features. It's especially useful for working with MkSaaS.

If you're using Cursor, you can take advantage of its AI capabilities to:

  1. Get context-aware code completions
  2. Generate code based on natural language prompts
  3. Refactor code intelligently
  4. Get documentation and explanations for complex parts of the codebase

User rules

MkSaaS includes several predefined Cursor rules in the .cursor/rules directory that provide coding best practices and guidelines for different technologies used in the project. These rules help maintain code quality and consistency:

typescript-best-practices.mdc
nextjs-best-practices.mdc
react-best-practices.mdc
tailwindcss-best-practices.mdc
radix-ui-best-practices.mdc
react-hook-form-best-practices.mdc
zustand-best-practices.mdc
drizzle-orm-best-practices.mdc
date-fns-best-practices.mdc
zod-best-practices.mdc
stripe-best-practices.mdc
ai-sdk-best-practices.mdc

These rules are automatically loaded in Cursor and can be applied to your code by selecting them from the Cursor rules panel. They provide context-aware guidance to improve your development workflow.

Documentation

To enhance your development experience, it's recommended to add the official documentation for key technologies to your Cursor documentation panel. This allows you to quickly reference documentation without leaving your editor.

Consider adding documentation from:

To add documentation in Cursor:

  1. Open Cursor Settings
  2. Go to the Features tab
  3. Go to the Docs panel
  4. Click the "+ Add new doc" button
  5. Add the documentation URL and name

Having these docs readily available in your IDE will significantly speed up development by reducing context switching.

Cursor docs

The project includes a .vscode/extensions.json file that will prompt you to install recommended extensions when you open the project in VSCode or Cursor. MkSaaS works best with the following extensions:

Biome

Biome is a powerful formatter, linter, and more for JavaScript and TypeScript projects. It's a high-performance replacement for tools like ESLint and Prettier, providing both formatting and linting capabilities in a single, fast package.

Download Biome extension

Tailwind CSS IntelliSense

Tailwind CSS IntelliSense provides autocomplete suggestions for Tailwind CSS classes, linting, and hover previews, making it much easier to work with utility-first CSS.

Download Tailwind CSS IntelliSense

i18n Ally

i18n Ally is a powerful internationalization extension for VSCode that helps you manage translations, provides autocomplete for keys, and shows inline translations in your code.

Download i18n Ally extension

GitLens

GitLens supercharges Git capabilities in VSCode/Cursor. It helps you visualize code authorship, seamlessly navigate through Git repositories, explore commit history, and compare changes right within your editor.

Download GitLens extension

MDX

The MDX extension provides syntax highlighting, intelligent language features, and rich editing support for MDX files. It's essential for working with documentation and content in the MkSaaS project.

Download MDX extension

The repository includes pre-configured settings in .vscode/settings.json that set up:

For the best development experience with MkSaaS:

Use the integrated terminal

Use the integrated terminal in VSCode/Cursor to run development commands without switching contexts.

Use the Source Control panel

The Git integration in VSCode/Cursor makes it easy to stage, commit, and push changes.

Take advantage of IntelliSense

The built-in IntelliSense for TypeScript and React helps you write correct code faster.

Use i18n Ally for translations

Leverage i18n Ally to manage translations directly within your editor, ensuring your application is properly internationalized.

Next Steps

Now that your editor is configured, explore these related topics: