This is a basic Product Management System app that includes the following modules:
- Item Module (w/ CRUD)
- Customer Module (w/ CRUD)
- Customer Item Module (w/ CRUD)
- Category Module
- Report Module
The basic idea behind the application is that an user can create/update/delete customers, Items, categories and assign items customers. Also add the ability to run reports listing items, customer, and items assigned to customers.
The applications is a Blazor web app written in .Net 8 using Entity Framework core and SQLlite.
This guide will walk you through the steps to set up and run the Blazor web app using the provided PowerShell script (setup.ps1
).
Before running the setup script, ensure you have the following prerequisites installed:
- .NET SDK (version 8) the setup will try to install .NET if it is not install but if it fails please install manually
- PowerShell (version 5.1 or later recommended)
When using this option make sure you do not have some agresive Antivirus that might consider the zip contains a virus.
You can manually download the project as a ZIP file by following these steps:
- Click on the green "Code" button located near the top-right corner.
- Select "Download ZIP" from the dropdown menu.
- Save the ZIP file to your desired location on your local machine.
- Extract the contents of the ZIP file to a folder.
You can clone the repository to your local machine using Git.
To clone the repository using Git, open your terminal or command prompt and run the following command:
-
Clone the Repository: Clone this repository to your local machine using Git:
git clone https://github.com/PedroSantanaDev/pms.git
Once you have cloned or downloaded the project, you'll need to navigate to the project directory in order to run the setup script.
If you prefer to use the Windows interface, you can navigate to the project directory using File Explorer:
- Open File Explorer.
- Navigate to the location where you cloned or extracted the project.
- Navigate to pms/pms.app to directory.
- Once you are inside the directory pms/pms.app right-click on the
setup.ps1
file. - Select "Run with PowerShell" from the context menu. 6. If you dont see a "Run with PowerShell" option select the option "Open in Terminal" and type .\setup.ps1 then hit enter. 7. If see a security warning prompt click on Open
- Follow the On-Screen Instructions: The setup script will perform the following tasks:
- Check if the .NET SDK is installed and install it if necessary.
- Restore NuGet packages.
- Apply Entity Framework Core migrations.
- Start the Blazor app in the default web browser.
If you're comfortable with the command line, follow these steps:
-
Open your terminal or command prompt.
-
Navigate to the project directory if you haven't already.
cd pms/pms.app
-
Run the following command:
.\setup.ps1
-
Follow the On-Screen Instructions: The setup script will perform the following tasks:
- Check if the .NET SDK is installed and install it if necessary.
- Restore NuGet packages.
- Apply Entity Framework Core migrations.
- Start the Blazor app in the default web browser.
This script will:
- Check if the .NET SDK is installed and install it if necessary.
- Restore NuGet packages.
- Apply Entity Framework Core migrations.
- Start the Blazor app.
Once the setup process is complete, the Blazor app will automatically open in your default web browser. If it doesn't open automatically, you can access the app by navigating to the URL displayed in your terminal in the message "Now listening on:" or command prompt after running the setup script.
The app requires authentication, please use the credentials below to sign in
- Enter the following credentials (username and password) in the provided fields.
- Email: admin@pms.com
- Password: Megatron4584$$
- Click on the "Log In" button to authenticate.
- Once authenticated, you should have access to the all app's features.
For project documentation please visit the Wiki
If you encounter any issues during the sign-in process, please refer to the app's documentation or contact the app's administrator for assistance.