Installation

This guide covers all the ways to install and configure My Project.

Requirements

• Node.js 18 or higher
• npm 9 or higher (or yarn/pnpm)

Package Managers

npm

1

npm install my-project

yarn

1

yarn add my-project

pnpm

1

pnpm add my-project

Configuration

Create a myproject.config.js file in your project root:

1
2
3
4
5
6
7
8
9
10
11
12
13

export default {
  // Source directory
  input: './src',

  // Output directory
  output: './dist',

  // Enable debug mode
  debug: false,

  // Plugin configuration
  plugins: [],
};

Environment Variables

You can also configure via environment variables:

Verifying Installation

After installation, verify it works:

1

npx my-project --version

You should see the version number printed to the console.

Troubleshooting

Common Issues

Permission errors on macOS/Linux:

1

sudo npm install -g my-project

Node.js version mismatch:

1
2

nvm install 20
nvm use 20

Cache issues:

1
2

npm cache clean --force
npm install