Installation

To get started with DevIniter templates, please follow these steps:

Prerequisites

Ensure you have the following tools installed on your system:

Nodejs (v20.0.0 or higher)
pnpm (v9.0.0 or higher)
npm (v10.0.0 or higher)

Note: We are actively working to expand support for additional Node.js versions and package managers such as Yarn.

Installing Template

We recommend starting a new template using deviniter, which downloads template for you automatically. To install a template, run:

Terminal

$ npx @deviniter/cli@latest

After running this command, our CLI will guide you through the setup process:

Terminal

What is your project name?

Enter a name for your new project (lowercase, no spaces)

Select a template: (use arrow keys to navigate)

- Next.js
- Vite

Once you’ve selected your template, DevIniter will automatically download and install all necessary dependencies for your project. This process may take a few minutes depending on your internet connection.

If you’re new to DevIniter, refer to our Template Structure guide for a comprehensive overview and to enhance your experience with our templates.

🪄 Tips For You

- Expected setup time is around 2-5 minutes for first-time users.

- Make sure to star our repository on GitHub to stay updated with new features and templates.

Starting Your Project

Navigate to your project directory and start it locally using one of these commands:

Terminal

$ cd your-project-name && npm run dev

If there is no other application running on port 3000, your project will start at localhost:3000.

🪄 Tips For You

- With Vite template, your project will start at localhost:5173 in default

Troubleshooting

Common Issues

Port Already in Use

Error: Something is already running on port 3000

Solution: Either close the application using port 3000 or modify the port in your configuration file.

Node Version Mismatch

Error: The engine "node" is incompatible with this module

Solution: Use nvm (Node Version Manager) to install and switch to the required Node.js version:

Terminal

$ nvm use 20

Package Installation Fails

Clear your package manager cache:

Terminal

$ npm cache clean --force

Ensure you have the necessary permissions
Check your network connection

Still Having Issues?

Check our FAQ page Coming
Join our Discord community Coming
Open an issue on our GitHub repository

Next Steps

After successful installation:

Review our guide Getting Started
Explore the Template Structure
Check out our Features Overview New

Templates Structure

Next.js

Full-stack React.js framework

Vite

Fast and Modern React.js Build Tool

Getting Started

Next.js