Quick Start Guide
Get nopCommerce running on your local machine in under 10 minutes.
Step 1: Clone the Repository
bash
git clone https://github.com/nopSolutions/nopCommerce.git
cd nopCommerceStep 2: Build the Solution
Using Visual Studio
- Open
nopCommerce.slnin Visual Studio 2022 - Set
Nop.Webas the startup project - Build the solution (
Ctrl+Shift+B)
Using Command Line
bash
# Restore dependencies
dotnet restore
# Build the solution
dotnet build
# Navigate to web project
cd src/Presentation/Nop.WebStep 3: Configure the Database
Option A: SQL Server Express (Recommended for Development)
- Ensure SQL Server Express is installed and running
- The installer will create the database automatically during first run
Option B: Use In-Memory Database (Quick Testing)
For quick testing without setting up a database, you can modify the startup to use an in-memory provider (not recommended for development).
Step 4: Run the Application
Using Visual Studio
Press F5 to run with debugging, or Ctrl+F5 to run without debugging.
Using Command Line
bash
cd src/Presentation/Nop.Web
dotnet runStep 5: Complete Installation Wizard
- Open your browser and navigate to
https://localhost:5001(or the URL shown in console) - Follow the installation wizard:
Installation Steps
- Store Information - Enter your store name and email
- Database Configuration - Select SQL Server and enter connection details
- Create Admin Account - Set up your administrator credentials
- Install - Click Install and wait for completion
Installation Wizard Fields
| Field | Description | Example |
|---|---|---|
| Admin Email | Administrator email | admin@yourstore.com |
| Admin Password | Min 6 characters | SecurePass123! |
| Database Server | SQL Server instance | localhost\SQLEXPRESS |
| Database Name | Will be created | nopCommerce_dev |
Step 6: Access Your Store
After installation completes:
- Public Store:
https://localhost:5001 - Admin Panel:
https://localhost:5001/Admin
Default Credentials
Use the admin email and password you created during installation to log in.
Verify Installation
Check These Features Work:
- [ ] Homepage loads correctly
- [ ] Admin login successful
- [ ] Can view product catalog
- [ ] Can access Configuration > Settings
Troubleshooting
Common Issues
Build Errors
bash
# Clean and rebuild
dotnet clean
dotnet build --no-incrementalDatabase Connection Failed
- Verify SQL Server is running
- Check the connection string in
App_Data\dataSettings.json - Ensure your SQL user has permission to create databases
Port Already in Use
Edit Properties/launchSettings.json to use a different port:
json
"applicationUrl": "https://localhost:5002;http://localhost:5003"Next Steps
Now that nopCommerce is running:
- Create Your First Plugin - Build a simple plugin
- Explore the Architecture - Understand how plugins work
- Set Up Your Development Workflow - Learn best practices