Dr. Sillystringz's Factory

This project acts as a relationship tracker between Engineers and Machines that they are licensed to work on.

Created by: github.com/mejia-dev

Technologies Used

• C#
• ASP.NET / MVC
• Entity Framework / EFCore
• MySQL
• Razor

Description

This project utilizes ASP.NET to allow a factory manager keep track of machines and the engineers that are licensed to fix them. The project is built in a many-to-many relationship format using EF Core and has full CRUD (Create, Read, Update, Delete) functionality on entities.

Features:

• Allows users full CRUD of engineers and machines.
• Allows users to assign a machine to any number of engineers.
• Allows users to assign an engineer to any number of machines.

1 - Setup/Installation Prerequisite Requirements

This section will cover how to install the .NET SDK and MySQL Community Server. If you already have these applications installed and running at at least version 8.0, proceed to the section Project Setup Requirements section below.

Prerequisite A: .NET SDK Installation

Step 1: Download .NET SDK

• Download the .NET 6 SDK (Software Development Kit). To view all download options for the .NET 6 SDK, visit this page. Or, click on any of the following links for an immediate download from Microsoft:

  For Windows

  For Macs with Apple Chip

  For Macs with Intel Chip

Step 2: Install the SDK

• Open the file. This will launch an installer which will walk you through installation steps. Use the default settings the installer suggests.

Step 3: Test Installation

• Confirm the installation is successful. First, restart your command line shell (Terminal or GitBash) if it's already open, and then run the command "dotnet --version" (without quotes). You should see a version number as a response.

Prerequisite B: MySQL Community Server

MacOS Instructions:

MacOS Step 1: Download the MySQL Community Server Installer

• Start by downloading the MySQL Community Server .dmg file from the MySQL Community Server page:

  For Catalina and above, AND an M2 chip

  For Catalina and above, AND an M1 chip

  For Catalina and above, AND an Intel chip

  For High Sierra or Mojave

MacOS Step 2: Install MySQL Community Server

• Launch the installer. Accept all prompts until you reach the Configuration page. Once you've reached Configuration, select or set the following options (use default if not specified):

  • Use Legacy Password Encryption.
  • Set password to a password of your choosing. This password will become necessary later for project setup.
  • Select "Finish".

MacOS Step 3: Configure Environment Variables

• Open the terminal to set your environment variables using either of the following commands. When finished, close all terminal windows.

  • For bash users:

    echo 'export PATH="/usr/local/mysql/bin:$PATH"' >> ~/.bash_profile

  • For zsh users:

    echo 'export PATH="/usr/local/mysql/bin:$PATH"' >> ~/.zshrc

MacOS Step 4: Test Installation (MySQL Community Server)

• From a new terminal window, attempt to login to mysql to confirm it is configured properly. Substitue "YOUR_PASSWORD_HERE" for the password you set during installation.

  mysql -uroot -pYOUR_PASSWORD_HERE

  There will be an intro message, and the prompt should change to: mysql> . This confirms that mysql is installed and everything is working as expected. If you instead receive a mysql: command not found error, attempt to uninstall any versions of the applications that are previously installed, then follow this installation guide again.

Windows 10/11 Instructions:

Windows Step 1: Download the MySQL Web Installer

• Download the MySQL Web Installer from the MySQL Downloads page.

Windows Step 2: Install the MySQL Web Programs

• Follow along with the installer as described below. If a step is not specifically listed, accept the defaults.

  • Select "Yes" if prompted to update.
  • Accept license terms.
  • Choose "Custom" setup type.
  • In the "Select Products and Features" menu, choose the following:
    • Check the box titled "Enable the Select Features page to customize product features".
    • Under MySQL Servers > MySQL Server > MySQL Server 8.0, select "MySQL Server 8.0.19" (or latest available version).
    • Under Applications > MySQL Workbench > MySQL Workbench 8.0, select "MySQL Workbench 8.0.19" (or latest available version).
  • Select "Next", then "Execute". Wait for download and installation. This can take some time.
  • Continue through the following Configuration steps:
    • Set "High Availability" to "Standalone".
    • Set "Type and Networking" to "Defaults are OK".
    • Set "Authentication Method" to "Use Legacy Authentication Method".
    • Set password to a password of your choosing. This password will become necessary later for project setup.
    • Set "Windows Service" to "Defaults are OK". Ensure that the following options are selected:
      • "Configure MySQL Server as a Windows Service".
      • "Start the MySQL Server at System Startup".
      • "Run Windows Service" should be set to "Standard System Account".
  • Complete the installation as prompted.

Windows Step 3: Configure Environment Variables

• The terminal (CLI, PowerShell, and GitBash) now need to be configured to recognize the mysql command. This can be done through changing the environment variables.

  • Press the Windows key and R key simultaneously to bring up the Run prompt.
  • In the run prompt, type in sysdm.cpl, then press Enter.
  • In the System Properties window that appears, navigate to the "Advanced" tab, then select "Environment Variables...".
    • In the Environment Variables window, under the "System Variables" section, double-click on the "Path" variable to launch it's editing window.
      • In the editing window, select the "New" button in the top right, then enter the installation path of the MySQL Server. For most installations, this should be C:\Program Files\MySQL\MySQL Server 8.0\bin, but may vary depending on the version installed.
      • When finished, select "OK".
    • Select "OK".
  • Select "Apply", then select "OK".

Windows Step 4: Test Installation (MySQL Community Server)

• Finally, from a new PowerShell window, attempt to login to mysql to confirm it is configured properly. Substitue "YOUR_PASSWORD_HERE" for the password you set during installation.

  mysql -uroot -pYOUR_PASSWORD_HERE.

  There will be an intro message, and the prompt should change to: mysql> . This confirms that mysql is installed and everything is working as expected. If you instead receive a The term 'mysql' is not recognized as the name of a cmdlet, function, script file, or operable program error, double-check that the environment variables were set up correctly. If all else fails, attempt to uninstall any versions of the applications that are previously installed, then follow this installation guide again.

2 - Project Setup Requirements

Step 1: Clone Repo

• Clone this repository to your desktop by running the following command from your Git Bash console:

   git clone https://github.com/mejia-dev/DrSillyStringzFactory.git

Step 2: Create appsettings.json

• This project requires a file titled appsettings.json residing in the project directory (not the root directory).

  • Navigate to the project directory:

    cd DrSillyStringzFactory/Factory

  • Create the file:

    touch appsettings.json

  • Using a text editor of your choice, modify the file to include the following JSON data:

    {
      "ConnectionStrings": {
        "DefaultConnection": "Server=localhost;Port=3306;database=dr_sillystringz_factory;uid=YOUR_USERNAME_HERE;pwd=YOUR_PASSWORD_HERE;"
      }
    }

    Please note that the DefaultConnection string is essentially broken up into five distinct lines. Replace data from the template as needed for your environment.

    • Server=localhost;
    • Port=3306;
    • database=dr_sillystringz_factory;
    • uid=YOUR_USERNAME_HERE;
    • pwd=YOUR_PASSWORD_HERE;

3 - Run the Project

• Navigate to the project directory, and to the project subfolder:

  cd DrSillyStringzFactory/Factory

• Run the following command to install dependencies:

  dotnet restore

• Run the following command to set up the database schema:

  dotnet ef database update

• Run the project using:

  dotnet run

Known Bugs

• none

Original Prompt:

You've been contracted by the factory of the famous Dr. Sillystringz to build an application to keep track of their machine repairs. You are to build an MVC web application to manage their engineers, and the machines they are licensed to fix. The factory manager should be able to add a list of engineers, a list of machines, and specify which engineers are licensed to repair which machines. There should be a many-to-many relationship between Engineers and Machines. An engineer can be licensed to repair (belong to) many machines (such as the Dreamweaver, the Bubblewrappinator, and the Laughbox) and a machine can have many engineers licensed to repair it.

User Stories

• As the factory manager, I need to be able to see a list of all engineers, and I need to be able to see a list of all machines.
• As the factory manager, I need to be able to select a engineer, see their details, and see a list of all machines that engineer is licensed to repair. I also need to be able to select a machine, see its details, and see a list of all engineers licensed to repair it.
• I should not be able to create an engineer or a machine if the form's fields are empty or contain invalid values.
• As the factory manager, I should be able to add new machines even if no engineers are employed. I should also be able to add new engineers even if no machines are installed.
• As the factory manager, I need to be able to add or remove machines that a specific engineer is licensed to repair. I also need to be able to modify this relationship from the other side, and add or remove engineers from a specific machine.
• I should not be able to add a machine to an engineer if there are no machines. Likewise I should not be able to add an engineer to a machine if there are no engineers.
• When I access the application, I should see a splash page that lists all engineers and machines.

License

MIT License

Copyright (c) 2023 github.com/mejia-dev

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.