Github Clone Installation

Introduction

This guide provides a step-by-step approach to installing and setting up Dotnet Report, a powerful Analytics and Reporting Tool, on your local machine. Whether you’re a developer integrating reporting into your application or an analyst or end user exploring data visualization, this guide will help you get started quickly and efficiently.

Dotnet Report is designed to make self-service reporting easy. With its intuitive interface and seamless database connectivity, you can:

• Connect to your SQL Server database effortlessly.
• Load and manage tables for reporting.
• Build interactive reports with a user-friendly UI.
• Create dashboards for powerful data visualization.

This guide is designed to help you seamlessly set up, configure, and utilize the software on your local machine. This guide will walk you through each step, from installation to creating dashboards, ensuring you can make the most of Dotnet Report’s useful features.

Why Install Using Git?

There are multiple ways to install Dotnet Report, but using Git provides key advantages:

• Get the Latest Code – Easily pull updates and stay up to date with new features and fixes.
• Get Started Fast – Using Git to install Dotnet Report is one of the fastest and easiest options. 
• Full Flexibility – Modify or extend the codebase to fit your specific needs.

Intended usage reminder

This Git-based installation is designed for standalone usage and local testing. It does not include the necessary integrations to embed Dotnet Report directly into your own applications. However, users can:

• Start with the standalone setup for local testing and configuration.
• Seamlessly transition to the embedded version later if needed, keeping all configurations, reports, and dashboards intact.
• Deploy the standalone version to any hosting provider of their choice once they’re ready to move beyond local testing.

This guide will walk you through cloning the repository, configuring your database connection, and running Dotnet Report locally, so you can start generating powerful insights in no time. Let’s get started! 

Let’s dive into the step-by-step process to get you started!

Step 1: Install Required Software

Before you can start using the software, you need to install the necessary tools and dependencies. Here’s what you need to do:

1. Install Git

Git is a version control system that allows you to clone the software repository from GitHub.

• Download Git: Visit the Git Official Website and download the installer for your operating system.
• Install Git: Run the installer and follow the on-screen instructions. Use the default settings unless you have specific preferences.
• Verify Installation: Open Command Prompt (cmd) or Git Bash and type:

git --version

If you see a version number, Git is installed successfully.

2. Install Node.js

Node.js is a JavaScript runtime that is required to manage the software’s dependencies.

• Download Node.js: Visit the Node.js Official Website and download the latest stable version.
• Install Node.js: Run the installer and follow the on-screen instructions.
• Verify Installation: Open Command Prompt (cmd) and type:

node -v

If you see a version number, Node.js is installed successfully.

3. Install .NET Core Runtime

The software is built on the .NET framework, so you’ll need to install the .NET Core Runtime.

• Download .NET SDK: Visit the Microsoft .NET Official Website and download the .NET SDK (not just the runtime).
• Install .NET SDK: Run the installer and follow the on-screen instructions.
• Verify Installation: Open Command Prompt (cmd) and type:

dotnet --version

If you see a version number, .NET is installed successfully.

Step 2: Clone the GitHub Repository

Now that you have the required software installed, it’s time to clone the software repository from GitHub.

1. Open Command Prompt or Git Bash: Launch your terminal application.
2. Navigate to Your Desired Directory: Use the cd command to navigate to the folder where you want to download the project. For example:

cd C:\Projects

3. Clone the Repository: Run the following command to clone the repository:

git clone https://github.com/dotnetreport/dotnetreport.git dotnetreport

This will download the project into a folder named dotnetreport.

4. Move into the Project Folder: Navigate into the downloaded folder:

cd dotnetreport

Step 3: Install Dependencies

With the repository cloned, the next step is to install the necessary dependencies.

1. Install Node.js Dependencies: Run the following command to install the required JavaScript libraries:

npm install

2. Compile Scripts: Run Gulp to process JavaScript and CSS files:

gulp scripts

Step 4: Build & Run the Project

Now that the dependencies are installed, you can build and run the project.

1. Build the Project: Compile the project by running:

dotnet build ReportBuilder.sln

2. Run the Project: Start the application by running:

dotnet run ReportBuilder.sln

Step 5: Open in Browser

Once the application is running, the terminal will display a localhost URL. Open this URL in your web browser to access the software.

Common Issues & Fixes

• If git clone fails: Ensure Git is installed correctly and restart your system.
• If npm install fails: Run npm cache clean --force and try again.
• If .NET build fails: Ensure you installed the .NET SDK, not just the runtime.

Steps to Run the App Again

1. Open Command Prompt (cmd) or Terminal
2. Navigate to the project folder

cd path/to/dotnetreport

(Replace path/to/dotnetreport with the actual folder path where you cloned the repository.)

3. Run the application

dotnet run ReportBuilder.sln

• This will start the app.
• Open the localhost URL shown in the terminal in your browser.

When Do You Need to Repeat Other Steps?

You only need to repeat certain steps in special cases:

• If you restart your computer → Just navigate to the folder and run dotnet run ReportBuilder.sln
• If you pull new changes from GitHub type git pull to Run dotnet build again.
• If you install new dependencies npm install then rerun gulp scripts

Conclusion

You’ve successfully installed the application! Now, to start building reports, connect your database and unlock the full potential of your .NET Report Builder. Once connected, you can effortlessly design, customize, and generate reports tailored to your needs. Get started now and turn your data into actionable insights!